Skip to main content

Contributing

info

For contributing to this documentation, see Improve docs.

We are grateful to the PastVu users community for adding photos and discussing them, helping to identify locations, improving information accuracy, taking responsibility by moderating uploaded content.

The are many more ways one can get involved:

Before reporting a bug or suggesting a feature, it might be a good idea to search if it has been reported already.

If you think you have found a security issue, please email at [email protected].

Code of Conduct​

We expect all project participants to follow code of conduct

Development​

We welcome any keen developer in helping us building the better PastVu! Any contributions are welcome, no matter how big or small.

Process​

All development takes place in PastVu GitHub repository, allowing the repository tools to be used for issue tracking, pull requests, testing and release management.

All pull requests are checked by the continuous integration system which has a range of unit tests, style and lint tests, build tests.

Where to start​

If you are new to Open Source contributions, you may find those guides useful:

If you've not contributed to PastVu before and would like to do so, the good starting point is a list of good first issues, each of them is relatively simple and will help you to familiarise with a code. If you have questions, you may ask them in the issue comments, or in discussion board.

Local Setup​

You will need a local development environment to start work on the project, see Getting started development manual for details.

Pull Requests​

Please make sure the following is done when submitting a pull request:

  1. Keep your PR small - make sure the PR changes belong to the same scope, otherwise please split them.
  2. Use descriptive commit message subjects - keep it short and focused, if more details needed write them in commit message body.
  3. Test your changes - make sure you tested changes on local dev server.

All pull requests should be opened against the master branch.

When PR is created, our integration systems will run automated tests to guard against mistakes. The maintainers will review your code, once PR is merged CI system will deploy them to documentation resources website.

Licensing​

By contributing to PastVu, you agree that your contributions will be licensed under its AGPLv3+ license. We are using simplified copyright header per Linux Foundation guidelines and single line license declaration. The following header should be present in all code files (except third-party source code, e.g. libraries):

/**
 * Copyright: The PastVu contributors.
 * GNU Affero General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/agpl.txt)
 */