Contribution Guidelines

By following these guidelines, you can help to ensure that your contribution is of high quality and properly aligned with the project’s overall goals.

We welcome contributions from the community! Whether it’s bug fixes, new features, or improvements to the documentation, your help is appreciated. Please follow the guidelines below to contribute to SustainDC.

How to Contribute

  1. Fork the Repository: Fork the SustainDC repository to your own GitHub account

  2. Clone the Repository: Clone the forked repository to your local machine:

git clone https://github.com/your-username/dc-rl.git

  1. Create a Branch: Create a new branch for your feature or bug fix:

git checkout -b feature-or-bugfix-name

  1. Make Changes: Make your changes to the codebase.

  2. Commit Changes: Commit your changes with a clear and descriptive commit message:

git commit -m "Description of your changes"

  1. Push Changes: Push your changes to your forked repository:

git push origin feature-or-bugfix-name

  1. Create a Pull Request: Open a pull request on the original SustainDC repository. Provide a clear description of what your changes do and any relevant information for the review process.

Code of Conduct

Please note that we have a Code of Conduct. By participating in this project, you agree to abide by its terms.

Reporting Issues

If you find a bug or have a feature request, please create an issue on the GitHub Issues page. Provide as much detail as possible to help us understand and address the issue.

Guidelines

  • Ensure your code follows the project’s coding standards and conventions

  • Write clear, concise commit messages

  • Update documentation if necessary

  • Add tests to cover your changes if applicable

Thank you for contributing to SustainDC!

Contact

If you have any questions, suggestions, or issues, please feel free to contact us. We are here to help and support you in using SustainDC.

License

MIT License

The majority of this project is licensed under the MIT License. See the LICENSE file for more details.

Creative Commons Attribution-NonCommercial 4.0 International License

Some parts of this project are derived from code originally published under the Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) License. The original authors retain the copyright to these portions, and they are used here under the terms of the CC BY-NC 4.0 license.

Attribution for CC BY-NC 4.0 Licensed Material

Combined Work

This combined work is available under both the MIT License for the new contributions and the CC BY-NC 4.0 License for the portions derived from the original work.