Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 3.88 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 3.88 KB

Contributing Guide

Fast Lane

If you just want to give a hint about a missing project, send an email at [email protected]. However, we would be pleased to add you to the list of official contributors via a pull request.

Guideline

Earth's uniqueness in creating a stable environment for life in a completely hostile space is a miracle. Various life forms have taken billions of years to build up the natural resources humans depend on, such as a protective atmosphere, fertile soil, stable weather, and clean drinking water. As a movement to democratize technology development and knowledge creation, open source has the potential to become the central driver in preserving this stability. Open Sustainable Technology's mission is to gather projects that preserve natural ecosystems through open technology, methods, data, intelligence, knowledge or tools.

Contributors

What Criteria Must a Project Meet to be Listed?

  • The project must comply as closely as possible with the guideline.
  • The projects must be actively be used or developed at the time of listing.
  • You need to show that others beyond the project's main developers are using the project. Good indicators are issues or pull requests from external users.
  • Your project should be structured and documented in such a way that it can be reused and extended by others.
  • If possible, the Git Link of the projects should be used for listing since this allows meta data analysis of the project. Thus, the project can become part of the data analysis and recurring report.
  • Larger parts of the project are published under an open source license.

Contribute to the List

  • Create a fork of this project.
  • Add your project in the following format:
    - [Project Name](Project URL) - A sentence that describes your project and what makes it different from others.
  • If available, use the Git link to the central repository of your project. This makes it easier for developers and maintainers to review the project faster.
  • Create a pull request and wait for the reaction of the maintainer.

More details on how to do pull requests can be found in the official GitHub documentation.

The Project Does Not Yet Meet the Criteria, What Now?

If your project doesn't meet the community, documentation, or usage criteria because it's in its early stages, don't hesitate to create a pull request. We will label the pull request "Under Observation" so that we can review it later. If you wish, we can use our social media channels to help you find contributing communities and users.

Post new entries on social media

To simply follow new project that have been reviewed successfully, the commit message of the merge will be posted on our Mastodon and Bluesky channel. To trigger the posting via GitHub Action, the reviewer of the project needs to add a short sentence describing your project and the full URL of your repository to the description of the merge commit.

Join the Community

We welcome developers, scientists, artists, writers, journalists, entrepreneurs, and citizens alike. Join our regular community calls to learn more about how you can make a difference through open source action on climate and sustainability.

<iframe src="https://calendar.google.com/calendar/embed?src=opensustaintech%40gmail.com&ctz=Europe%2FBerlin" style="border: 0" width="800" height="600" frameborder="0" scrolling="no"></iframe>