Thank you for your interest in contributing to Climate Connect!
Table of Contents:
Feature requests should be reported in the Climate Connect issue tracker. To avoid duplicates, please make sure to check existing issues.
Bug reports should be reported in the Climate Connect issue tracker.
To report a bug follow these guideline.
- Describe the issue: Fill in a concise description of what went wrong
- Steps to recreate: List every step you took that led to the unexpected result.
- Expected result: Fill in what you would have expected after the last step in "Steps to recreate"
- Actual result: Explain what actually happened
- Link: Please provide a link to this issue.
If you are looking for a place to start contributing to Climate Connect, take a look at the good first issues and the beginner level issues.
When creating a pull request (PR) follow these guidelines.
- Ensure you're starting off a new branch, that's checked out from the latest master. The project uses a single branching model off master (no develop branches).
- Add concise description to the PR summary.
- Add detailed steps to for testing a feature or bug.
- If there is code unrelated to feature or a bug in the PR, please list all changes.
- After approval, ensure that you squash merge your PR.
Code should be documented where appropriate. The general Python and JavaScript rules can be followed for formatting.
If there are any outstanding questions about contributing to Climate Connect, they can be asked on the Climate Connect issue tracker.
For a more immediate and direct form of communication, please tag core contributors @positiveimpact and @ddhanesha on an issue.