Skip to content

Latest commit

 

History

History
71 lines (40 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

71 lines (40 loc) · 3.32 KB

Contributing to GIFramework Maps

Thanks for your interest in contributing to GIFramework Maps. Please see the project's Code of Conduct before proceeding.

Submitting Bug Reports

Please use the GitHub issue tracker. Before creating a new issue, do a quick search to see if the problem has been reported already.

Contributing Code

See DEVELOPING.md to learn how to get started developing.

Our preferred means of receiving contributions is through pull requests. Make sure that your pull request follows our pull request guidelines below before submitting it.

Before starting work on a feature or issue, make sure you let us know by adding a comment to the relevant issue in the issue tracker.

If you are looking to build new functionality or change something quite significantly, please check with the core developers before starting work to make sure it is something we are happy for you to do.

This page describes what you need to know to contribute code to GIFramework Maps as a developer.

Contributor License Agreement

Your contribution will be under our license as per GitHub's terms of service.

Pull request guidelines

Before working on a pull request, create an issue explaining what you want to contribute. This ensures that your pull request won't go unnoticed, and that you are not contributing something that is not suitable for the project. Once a core developer has set the accepted label on the issue, you can submit a pull request. The pull request description should reference the original issue.

Your pull request must:

  • Pass the tests run automatically by the Continuous Integration system

  • Address a single issue or add a single item of functionality

  • Contain a clean history of small, incremental, logically separate commits

  • Use clear commit messages

  • Be possible to merge automatically

Pull requests should merge into the main branch.

Address a single issue or add a single item of functionality

Please submit separate pull requests for separate issues. This allows each to be reviewed on its own merits.

Contain a clean commit history

The commit history explains to the reviewer the series of modifications to the code that you have made and breaks the overall contribution into a series of easily-understandable chunks. Try not to submit commits that change thousands of lines or that contain more than one distinct logical change.

Use clear commit messages

Commit messages should be short, begin with a verb in the imperative, and contain no trailing punctuation.

Please keep the header line short where possible.

Be possible to merge automatically

Occasionally other changes to main might mean that your pull request cannot be merged automatically. In this case you may need to rebase your branch on a more recent main, resolve any conflicts, and git push --force to update your branch so that it can be merged automatically.