From fdea142b8895b61385373bf897e9e94eab761559 Mon Sep 17 00:00:00 2001 From: hanopcan Date: Thu, 20 Jun 2024 13:51:14 +0100 Subject: [PATCH 1/2] Submit typo fixes and clarify new issues section --- CONTRIBUTING.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e80e5f5..21a5afc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,20 @@ # Contributing to CO2.js -Thank you for considering contributing to CO2.js. Open source is at the heart of our work, and we welcome input and contributions from the community across all our projects. +Thank you for considering contributing to CO2.js. Open source is at the heart of our work at [Green Web Foundation](https://www.thegreenwebfoundation.org/), and we welcome input and contributions from the community across all our projects. ## Getting Started - Submit a [new issue](https://github.com/thegreenwebfoundation/co2.js/issues/new/choose), or add additional comments to an [existing issue](https://github.com/thegreenwebfoundation/co2.js/issues). - - Our issue template provide you with a scaffold to follow when raising a new issue. - - For bugs, clearly describe the problem you are facing including steps to reproduce when it. - - For new features, clearly describe the new feature you'd like to see added and provide a reason for why it should be added. - - To request a carbon estimation model be added to CO2.js, please provide as much information about the model as possible including links to additional documentation and information about how the model is licensed. -- For bug reports, please also be sure to include the information about the environment your code was running in (e.g. NodeJS, Deno, Edge Worker, Browser etc). -Changes made that are not linked to an existing issue will not be accepted. +**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 three formats to choose from: + 1. *Bugs* - clearly describe the problem you're facing including steps to reproduce it. Please also be sure to include the information about the environment your code was running in (e.g. NodeJS, Deno, Edge Worker, Browser etc). + 1. *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. + 1. *Request addition of carbon estimation model to CO2.js* - please provide as much information about the model as possible including links to additional documentation and information about how the model is licensed. + + ## Making Changes @@ -23,13 +26,13 @@ Changes made that are not linked to an existing issue will not be accepted. ## Submitting Changes - Push the changes made in your branch to your fork of this repository. -- Submit a pull request this the repository in the `thegreenwebfoundation` organization. +- Submit a pull request to the CO2.js repository in the `thegreenwebfoundation` organization. - Your pull request description should follow the structure outlined in our pull request template. - - Be sure to 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 -- You pull request will be reviewed by a maintainer from Green Web Foundation. + - 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. -After a pull request is merged, you will be added to the project as a contributor. A maintainer will update the `.all-contributorsrc` file for this project to include your profile which will then add it to the list of contributors shown in this project's readme. +After a pull request is merged, you will be added to the project as a contributor. A maintainer will update this project's `.all-contributorsrc` file to include your profile which adds it to the list of contributors shown in this project's readme. ## Code of Conduct @@ -37,4 +40,4 @@ Please note that this project is released with a [Contributor Code of Conduct](h ## Thank you -Again, thank you for your contributions. We appreciate your help improving CO2.js, and we look forward to your future contributions. +Again, thank you for your contributions. We appreciate your help improving CO2.js, and we look forward to your future contributions! \ No newline at end of file From 430683cde71ef38ce1e06d64283f969151a645c9 Mon Sep 17 00:00:00 2001 From: hanopcan Date: Thu, 20 Jun 2024 14:02:49 +0100 Subject: [PATCH 2/2] Explain pull request termplate a little more clearly --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21a5afc..dbc1f69 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,9 +26,12 @@ Thank you for considering contributing to CO2.js. Open source is at the heart of ## Submitting Changes - Push the changes made in your branch to your fork of this repository. -- Submit a pull request to the CO2.js repository in the `thegreenwebfoundation` organization. - - Your pull request description should follow the structure outlined in our pull request template. - - 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. +- Submit a [pull request](https://github.com/thegreenwebfoundation/co2.js/pulls) to the CO2.js 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.