Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

81 lines (54 loc) · 3.08 KB

Contributing to EnviroX

🎉 First off, thanks for taking the time to contribute to EnviroX! We value your input, whether it's reporting bugs, suggesting features, or writing code. Let's work together to make development environments easier for everyone.

🛠 How to Contribute

There are several ways you can contribute to EnviroX:

  • Submit a Bug Report: Found a bug? Let us know! Open a new issue with a detailed description, steps to reproduce, and any error logs.
  • Suggest a Feature: Got an idea? We'd love to hear it! Submit a feature request by opening an issue or discussing it in an existing thread.
  • Code Contributions: Ready to get your hands dirty? You can contribute code for bug fixes, feature implementations, or improvements. Check the "Getting Started" section below.

📋 Code of Conduct

Please note that this project is governed by a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

🛠 Getting Started with Contributions

Follow these steps to contribute:

1. Fork the Repository

Fork the repository from EnviroX GitHub Repo. This will create a copy under your GitHub account.

2. Clone the Forked Repository

Once forked, clone the repository to your local machine:

git clone https://github.com/your-username/envirox.git

3. Create a Branch

Create a new branch to work on your changes:

git checkout -b feature-or-bugfix-name

4. Install Dependencies

Run the following command to install the dependencies required for EnviroX:

npm install

5. Make Your Changes

Write code, fix bugs, or implement features! Be sure to write tests if applicable.

6. Run Tests

Before submitting your changes, run the test suite to ensure everything works as expected:

npm run test

7. Commit and Push

Once you're satisfied with your changes, commit and push your code:

git add .
git commit -m "Description of the changes"
git push origin feature-or-bugfix-name

8. Submit a Pull Request

Head to the EnviroX repository on GitHub and submit a pull request (PR) from your fork. Be sure to include a detailed description of your changes. One of the maintainers will review your PR and provide feedback or merge it if it’s ready.

🚨 Guidelines for Contributions

  • Keep commits focused and concise. One feature or bug fix per PR is best.
  • Always update/add tests for any new functionality.
  • Follow the existing code style and structure.
  • Ensure your changes pass the test suite before submitting a PR.
  • Contributions should follow the principles of the Apache 2.0 License.

💬 Need Help?

If you have any questions or run into issues, feel free to open a discussion or issue on the GitHub Repo. We’re here to help!

By contributing to EnviroX, you agree that your contributions will be licensed under the Apache 2.0 License.