Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 2.73 KB
Raw

Contributing to Green Web Foundation - Developer Docs Website

Thank you for considering contributing to Green Web Foundation - Developer Docs Website. 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

  • Our issue template provides you with a scaffold to follow when raising a new issue. There are two formats to choose from:
    • Bugs - clearly describe the problem you are facing including steps to reproduce when it. Please also be sure to include the device, browser, and OS you were using.
    • New features - clearly describe the new feature you'd like to see added and provide a reason for why it should be added. eg what will be improved/possible as a result of making your suggested change.

Making Changes

  • Fork the repository on GitHub. Create a new fork.
  • Create a topic branch from where you want to base your work. This branch should usually be based off main.
  • Make commits of logical units.
  • Make commit messages clear and understandable.

Submitting Changes

  • Push the changes made in your branch to your fork.
  • Submit a pull request to the Developer Docs repository in the thegreenwebfoundation organization.
    • When opening a new pull request, you'll see a template. Please follow it. It asks you to state:
      • link to the related issue
      • what your changes are - be sure to should clearly explain the changes you have 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 Green Web Foundation - Developer Docs Website, and we look forward to your future contributions.