Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 3.3 KB
Raw

Contribution Guide

Guideline

For technology to be truly sustainable, everyone must have access to it and be able to adapt it to their needs. Climate change and the loss of natural resources are globally emerging challenges. protontypes is starting the unique attempt to map all open sustainable technology in one list. By spreading knowledge in this domain with open software, standards, tools, and platforms a sustainable economy can be reached in a much shorter timespan.

What criteria must my project meet to be considered?

  • The project must comply as closely as possible with the Guideline.
  • You need to show that others than the project main developers are using the project. A good indicator are issues created by external users.
  • Your project should be structured and documented in such a way that it can be reused and extended by others.
  • Larger parts of the project are published under an open source license.
  • Have good reasons why the project is awesome and why it is useful.

Contribute to the list

Additions to the list are done by pull requests.

  • Every new project on the list needs to be a new pull request.
  • Create a fork of awesome-sustainable-technology.
  • Insert the project into one of the categories of your fork. We can discuss later on in the 'Pull Request' comments whether another category fits better or we need to open a new one.
  • Add your project in the following format: - [Project Name](Project URL) - A sentence that describes your project and what makes it different from others.
  • Describe in at least one sentence why you think the project meets the guidelines.
  • Create a pull request and wait for the reaction of the maintainer. We may ask you additional questions or you may need to make changes to your pull request.
  • To reorder the list or for creating new categories please open an issue. After a discussion in the issue comments, we can decide on how to reorganize the list based on a pull request from you.
  • Every new project entry will receive a tweet created by protontypes. You can define a custom message for that with your project URL and great people if you like to. Just add My Tweet: to the Pull request comment.

Further details on how do Pull Requests can be found in the official GitHub documentation.

Planting trees

We are dependent on your support. To motivate you to add projects and maintain the list, we plant 100 trees for each merged pull request. Together with our partners of DigitalHumani we created Continuous-Reforestation to automate the tree planting process.

Where and How to find further projects

Almost all open source projects are using git for cooperation. Thats why git, gitlab or github are always good key terms to identify new projects for this list. The following search engines can be helpful to find further projects:

  • GitHub
  • Gitlab
  • Google Scholar
  • DuckDuckGo
  • Google
  • Zenodo
  • Libraries.io
  • Doaj.org
  • The Journal of Open Source Software - The Journal of Open Source Software is a developer friendly, open access journal for research software packages.