Contributors guide

README.md

@@ -1,6 +1,6 @@
-# awesome-green-extensions
-A list of climate friendly browser extensions and scripts that can help you reduce the carbon footprint of your internet consumption. 
-It is conceived as a valuable resource in its own right, and as Research and Development for the [Adora Foundation](adorafoundation.org)'s [Green Mode Design](ismaelvelasco.dev/series/green-mode-design) programme.
+# :deciduous_tree: awesome-green-extensions
+Welcome to this list of climate friendly browser extensions and scripts that can help you reduce the carbon footprint of your internet consumption! 
+It's conceived as a valuable resource in its own right, and as research and development for the [Adora Foundation](adorafoundation.org)'s [Green Mode Design](ismaelvelasco.dev/series/green-mode-design) programme.
 
 ## Contents
 
@@ -9,6 +9,11 @@ It is conceived as a valuable resource in its own right, and as Research and Dev
 - [Carbon offset generators](#carbon-offset-generators)
 - [Graceful degradation tools](#graceful-degradation-tools)
 
+## Contribute!
+We are always looking to grow this list, and we often have issues open for this project where a helping hand would be most appreciated by the team!
+To learn how you can contribute to this open source project, check out our contributors guide [here](/contributors-guide.md).
+
+***
 ## CO2 emissions trackers and green website raters
 
 ### Globemallow

contributors-guide.md

@@ -0,0 +1,68 @@
+# awesome-green-extensions contributor guidelines
+
+Hi there! If you’ve found yourself on this page, you’re clearly thinking about contributing to this open source repo – how exciting! A big warm welcome from the team here at the Adora Foundation 🤗
+
+In this guide we’ll aim to give you all the information you need to make it easy for you  to contribute. If you have any suggestions for how we could improve this guide, come and join the [Adora Foundation slack community](https://join.slack.com/t/adora-foundation/shared_invite/zt-1otudjm68-Hzzl4Cs_BA~HnpGXHfHrhQ) and chat to us in the *#project-awesome-green-extensions* channel.
+
+## an intro to the awesome-green-extensions project
+
+The awesome-green-extensions project is both a research project and a valuable resource for anyone wanting to monitor and reduce the carbon emissions of their browsing.
+
+The extensions and user scripts collected through this project are used as research and development for the Adora Foundation's [Green Mode Extension](https://github.com/Adora-Foundation/green-mode-extension) – an extension that allows you to green all the websites you visit and reduce your environmental footprint while browsing!
+
+Each extension listed here provides a description, browser compatibility information and links (so you can add the extension yourself), extension size, and the date the extension was last updated (as of when the extension info was last checked by us). Use these extensions for your own research into developing green extensions (the more the merrier after all) or simply use what exists to make your browsing more environmentally friendly 💚
+
+## what do I need to know to help?
+If you're looking to help with a code contribution, our project uses markdown and a [simple template](#resources). 
+
+If you don't feel ready to make a code contribution yet, no problem! You're welcome to check out the [project issues](https://github.com/Adora-Foundation/awesome-green-extensions/issues) to see what needs to be done. And you can always comment on an issue with a question if it needs more attention.
+
+If you are interested in making a code contribution to this repo, below are some helpful resources about working with markdown and the Adora Foundation. 
+- [Guide to working with Markdown (markdownguide.org)](https://www.markdownguide.org/getting-started/)
+- [Learn more about the Adora Foundation](https://github.com/Adora-Foundation)
+- [Adora Foundation green mode design program](https://ismaelvelasco.dev/series/green-mode-design)
+
+## how do I make a contribution?
+
+Here's a quick rundown of the steps you can take to contribute to this project!
+
+1. Find an issue that you are interested in addressing or an extension that you would like to add to the list.
+2. [Fork this project repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) . This means that you will have a copy of awesome-green-extensions repository under your-GitHub-username/repository-name.
+3. [Clone the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) to your local machine using git clone.
+4. Create a new branch for your fix using `git checkout -b branch-name-here`.
+5. Make the appropriate changes for the issue you are trying to address or the extension information that you want to add. If you are adding an extension to the list please [follow this template](#resources).
+6. Use `git add insert-paths-of-changed-files-here` to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
+7. Use `git commit -m "Insert a short message of the changes made here"` to store the contents of the index with a descriptive message.
+8. Push the changes to the remote repository using `git push origin branch-name-here`.
+9. Submit a pull request to the upstream repository.
+10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added information to resolve issue #1111".
+11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
+12. Wait for the pull request to be reviewed by a maintainer.
+13. Make changes to the pull request if the reviewing maintainer recommends them.
+14. Woohoo! Your pull request has been merged. Celebrate your success 🥳 Thank you so much!
+
+## where can I go for help?
+If you need help, you can ask a question on an issue you are looking at resolving or join the [Adora Foundation slack community](https://join.slack.com/t/adora-foundation/shared_invite/zt-1otudjm68-Hzzl4Cs_BA~HnpGXHfHrhQ) and drop your question in the *#project-awesome-green-extensions* channel.
+
+## resources
+1. Extension template (markdown - *To be used when inserting a new extension to the list*)
+
+```
+### NAME
+
+#### Description
+
+#### Browser compatibility
+
+
+#### Extension URL
+
+#### Extension size
+
+#### Extension last updated
+
+* * *
+
+```
+
+### [back to the awesome-green-extensions list](/README.md)