Skip to content

Latest commit

 

History

History
58 lines (34 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

58 lines (34 loc) · 3.23 KB
Raw

So you would like to contribute to the Litter Map software platform?

Wonderful! No previous qualifications are required. However, the following guidelines are important:

  • We want this to be a robust, extensible platform that will endure the test of heavy usage
  • We want to be conscious about performance
  • We want to have a nice community of people who respect each other
  • Despite its sophistication, we want the project to be approachable to contributors
  • We'd like to build this platform in a way that outsiders can understand how it works

Also, we invite you to use anything from this project in your open source project. The code, contributed by the contributors, is published under the AGPL-3 or later license.

If you'd like to simply report a bug, please check to see if an issue already exists, and if not create one.

If you have a question or would like to start a new topic, check the discussion board.

Code contributions are not the only way to help. Answering questions, helping others, reaching out and improving the documentation are immensely valuable to the community.

The project's direction of development

Our goal is to create the best global website for people to share information about littered locations and to create a place through which everyone worldwide can effectively collaborate on cleaning up our planet without the necessity of even knowing each other.

First and foremost, we want to promote a collaborative and respectful community. Therefore, we ask that all community members be kind and considerate regardless of circumstances.

License

By contributing code to the Litter Map project, you assert that:

  • You have the rights to contribute the code, either as its original author, or due to it being released to you under a compatible license
  • You are not aware of any third party claims on the code, including copyright, patent, trademark, or any other legal claim

You agree to:

  • License your contribution under the terms of the AGPL-3 or later license

You retain the copyright to your work. By contributing to the Litter Map project you simply agree to release it as free software under the AGPL-3.0-or-later license.

Effective contribution

Commits

Please look at the history to see what the existing commit messages look like. Then, please thoughtfully include:

  • A short summary (title)
  • A longer description that gives a good overview of the changes

It is of incredible value to be able to tell what each commit does just by reading its message.

Pull requests (should really be called merge requests)

In order for the pull request to be of good quality:

  • Don't be reluctant to @mention any relevant people
  • Please include clear and meaningful git commit messages
  • Fork the project and make your changes in a dedicated feature branch
  • Make sure your familiarity with the project is thorough enough

We are interested in quality contributions, so please take your time, and please ask any relevant questions on the discussion board.