Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 3.33 KB
Raw

Contributing to CO2.js

Thank you for considering contributing to Grid-aware Websites. Open source is at the heart of our work at Green Web Foundation, and we welcome input and contributions from the community across all our projects.

Getting Started

NB Changes/commits that are not linked to an issue will not be accepted.

New issues

There are currently no issue templates for this project. Please provide as much detail, context, and additional information in your issue as possible. For bug reports, please try to link to an example or repository that contains a reproduction of the bug.

Making Changes

  • Fork the repository on GitHub.
  • Create a topic branch from where you want to base your work. This branch should usually be based off main.
  • Remember to add JSDoc comments to any new functions or variables that you are introducing into the codebase.
  • Make commits of logical units.
  • Make commit messages clear and understandable.

Submitting Changes

  • Push the changes made in your branch to your fork of this repository.
  • Submit a pull request to the Grid-aware Websites repository in the thegreenwebfoundation organization.
    • When opening a new pull request, you'll see a template. Please follow it. It asks you to state:
      • the type of change (choose from a list)
      • link to the related issue
      • what documentation needs updating as a result (choose from a list)
      • what your changes are - be sure to clearly explain the changes you've made, any new files, dependencies, or network requests that have been added, and provide any additional context to help reviewers understand the changes made.
  • Your pull request will be reviewed by a maintainer from Green Web Foundation.
  • After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Thank you

Again, thank you for your contributions. We appreciate your help improving Grid-aware Websites, and we look forward to your future contributions!