We welcome contributions to mappyfile, in the form of issues, bug fixes, or suggestions for enhancements. This document sets out our guidelines and best practices for such contributions.
It's based on the Contributing to Open Source Projects Guide.
mappyfile has the following modes of contribution:
- GitHub Pull Requests
Contributors to this project are expected to act respectfully toward others in accordance with the Code of Conduct.
Before submitting a bug, please do the following:
-
Perform basic troubleshooting steps:
- Make sure you're on the latest version. If you're not on the most recent version, your problem may have been solved already! Upgrading is always the best first step.
- Search the issue tracker to make sure it's not a known issue.
Make sure your report gets the attention it deserves: bug reports with missing information may be ignored or punted back to you, delaying a fix. The below constitutes a bare minimum; more info is almost always better:
- What version of Python are you using? For example, are you using Python 2.7, Python 3.7, PyPy 2.0?
- What operating system are you using? Windows (7, 8, 10, 32-bit, 64-bit), Mac OS X, (10.7.4, 10.9.0), GNU/Linux (which distribution, which version?) Again, more detail is better.
- Which version or versions of the software are you using? Ideally, you've followed the advice above and are on the latest version, but please confirm this.
- How can the developers recreate the bug on their end? If possible, include a copy of your code, the command you used to invoke it, and the full output of your run (if applicable.)
Your contribution will be under our license as per GitHub's terms of service.
- Pull requests may include copyright in the source code header by the contributor if the contribution is significant or the contributor wants to claim copyright on their contribution.
- All contributors shall be listed at https://github.com/geographika/mappyfile/graphs/contributors
- Unclaimed copyright, by default, is assigned to the main copyright holders as specified in https://github.com/geographika/mappyfile/blob/master/LICENSE
-
Always make a new branch for your work, no matter how small. This makes it easy for others to take just that one set of changes from your repository, in case you have multiple unrelated changes floating around.
- Don't submit unrelated changes in the same branch/pull request! If it is not possible to review your changes quickly and easily, we may reject your request.
-
Base your new branch off of the appropriate branch on the main repository:
- In general the released version of mappyfile is based on the
master(default) branch whereas development work is done under other non-default branches. Unless you are sure that your issue affects a non-default branch, base your branch off themasterone.
- In general the released version of mappyfile is based on the
-
Note that depending on how long it takes for the dev team to merge your patch, the copy of
masteryou worked off of may get out of date!- If you find yourself 'bumping' a pull request that's been sidelined for a
while, make sure you rebase or merge to latest
masterto ensure a speedier resolution.
- If you find yourself 'bumping' a pull request that's been sidelined for a
while, make sure you rebase or merge to latest
- Please follow the coding conventions and style used in the mappyfile repository.
- mappyfile endeavours to follow the PEP-8 guidelines.
We welcome suggestions for enhancements, but reserve the right to reject them if they do not follow future plans for mappyfile.