Contribute to DotSpatial
DotSpatial is driven by the community and contributors like you. We are excited that you're interested to help us move forward and improve DotSpatial.
The flow when contributing to DotSpatial is as follows:
- Add issue (bug or new feature)
- Wait for issue to be tagged
- Commit your changes and rebase
- Create a pull request
Note that your contributions must be your own work and licensed under the same terms as DotSpatial.
First, search the issue tracker to see if the bug is already there. Please use the discussion forums if you are unsure whether it is a bug in the library or a problem in your code. When you are sure, please add defects in the issue tracker.
Please use markdown to format your code blocks with syntax highlighting to make it easier for everyone to read.
A bug report should include:
- used platform and tools version
- used DotSpatial version
- version of dependencies
- description of the issue
- sample code to reproduce the issue
Suggesting new features
Please use the discussion forums or add it directly in the issue tracker in the same way as bug reports.
Create your own fork
- Log in to GitHub and open the DotSpatial origin repository. Click the "Fork" button to create your own fork of the repository.
- Create a clone on your local system:
git clone https://github.com/yourusername/DotSpatial.git
You should base your work on the
Create a branch for the bugfix/feature you want to work on:
git branch bugfix-some-error
Checkout the branch:
git checkout bugfix-some-error
Commit your changes
Please follow the style of the other messages in the commit history. Explain the intentions for the change and include the issue number. Include the issue number in the commit message, e.g. "#9945".
Please follow the coding-style:
- include XML comments for all methods, properties and fields
- use linq method syntax (not query syntax)
- keep it simple
To commit your changes, use the git command:
git commit -m <msg>
When you are ready to make a pull request, please
More info about rebasing
Finally, push your commits:
Requirements for a pull request
- Include examples or unit tests for the change / new feature
- Update the CHANGELOG.md file
- Update the CONTRIBUTORS file if you are not already listed there
- Commits are rebased and squashed
Creating a pull request
- Open the GitHub page for your fork and create a "Pull Request" (PR)
- Include the issue number in the pull request comment (not in the title where it will not be linked!)
When the PR is submitted, Appveyor will build the code and report if the build was successful. A team member will then review the PR, and merge the branch if everything looks OK.
If there are some issues with the PR, you must
- update your code and commit changes
- rebase and squash again
- force push:
git push -f
The PR will be updated automatically when you push your changes.
To prevent the issue (backlog) list to grow indefinitely, an issue will be closed when you are not responding to requests by a project developer. We need your help, so we will not close an issue by desire. But when you are not answering to a request by for a month we will close the issue. If this happens in accident, feel free to re-open the issue...
The issue reporter can close the issue because:
- he/she verified the fix/change
- found out that it is not an DotSpatial issue but some problem in his/her code
In case the reporter does not respond to a request:
- a project developer is allowed to close the issue (after one month)
Someone can take over the issue from the reporter, when:
- he/she can reproduce the issue
- has some sample code
- has more time/information to assist in the resolution
- responds to requests by a project developer