Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
152 lines (98 loc) · 4.15 KB

CONTRIBUTING.md

File metadata and controls

152 lines (98 loc) · 4.15 KB
Raw

🤝 Contributing to Ecomine

Thank you for your interest in contributing to Ecomine! We’re excited to have you on board. By contributing, you’re helping us build a more sustainable and impactful project. Please follow these guidelines to make the process smooth and collaborative.

📝 How to Contribute

1. Fork the Repository

Create a copy of the project under your GitHub account by forking the repository. This ensures that your changes won't affect the original project.

To fork the repository:

2. Clone Your Fork

Clone the repository to your local machine so you can start making changes.

git clone https://github.com/YOUR-USERNAME/ecomine.git
cd ecomine

3. Create a New Branch

Create a separate branch for your feature or fix. Use a descriptive name to reflect your changes.

git checkout -b feature/your-feature-name

4. Make Changes

Start making changes to the codebase. Be sure to:

  • Write clean and readable code.
  • Follow the coding guidelines outlined below.
  • Test your changes thoroughly.

5. Commit Your Changes

Once your changes are ready, commit them with a clear and concise commit message. Follow conventional commit standards for consistency.

git add .
git commit -m "feat: add new feature description"

6. Push to Your Fork

Push your branch to your forked repository.

git push origin feature/your-feature-name

7. Open a Pull Request

Create a pull request (PR) to propose your changes to the main repository.

  • Go to your forked repository on GitHub.
  • Click the "New Pull Request" button.
  • Provide a detailed description of your changes, including:
    • What you’ve done.
    • Why your changes are necessary.
    • Any additional context.

Make sure your branch is up to date with the latest changes from the original repository to avoid merge conflicts.

🎨 Code Style Guidelines

To maintain consistency across the codebase, please follow these guidelines:

  • Use camelCase for variable and function names.
  • Keep functions small and focused on a single task.
  • Write meaningful comments to explain complex logic.
  • Use ESLint to ensure code quality.
  • Follow the project’s established folder and file structure.

🐛 Reporting Bugs

If you find any bugs, please help us by reporting them:

  1. Navigate to the Issues Tab.
  2. Click "New Issue."
  3. Provide a detailed description, including:
    • Steps to reproduce the bug.
    • Expected vs. actual behavior.
    • Screenshots or logs, if applicable.

🚀 Suggesting Features

We’d love to hear your ideas! To suggest a new feature:

  1. Navigate to the Issues Tab.
  2. Click "New Issue."
  3. Use the "Feature Request" template and include:
    • A brief description of the feature.
    • Why it’s valuable to the project.
    • Any relevant details or examples.

🤖 Testing Your Changes

Testing is crucial to ensure your changes don’t break existing functionality. Here’s what you can do:

  • Run the existing test suite using the project’s testing framework (e.g., Jest, Mocha).
  • Add tests for new functionality where applicable.
  • Ensure all tests pass before submitting a pull request.

🔄 Keeping Your Fork Updated

Before opening a pull request, sync your fork with the main repository to avoid conflicts.

  1. Add the original repository as a remote:

    git remote add upstream https://github.com/2004yash/ecomine.git

  2. Fetch and merge the latest changes:

    git fetch upstream
git checkout main
git merge upstream/main

💬 Communication

If you need help or have questions, feel free to reach out via:

🌟 Acknowledgments

Thank you for contributing to Ecomine! Your time and effort help us create a better platform and promote sustainability. Together, we can make a positive impact! 🌍✨