This repository has been archived by the owner on Jun 22, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added CONTRIBUTING guidelines, LICENSE file and icon. Updated README.
- Loading branch information
Showing
4 changed files
with
24 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Contributing | ||
|
||
So, you're thinking about contributing to NTS. Awesome! We have a few basic rules to make sure maintaining NTS is sustainable with limited time available. | ||
|
||
### What can you do to help? | ||
|
||
- Documentation & samples: If you need or find undocumented features. Or you asked a question please think about documenting this for future users. You can also contribute a sample application if the use case is generic enough. Otherwise, just upload the sample project to a seperate repo and we can link to it. | ||
- Bug reports: Very important, if something doesn't work as expected please [report the issue](https://github.com/NetTopologySuite/GeoAPI/issues). | ||
- Bug fixes: Even better, if you can fix something, please do! | ||
- Feature requests: Need something that's not there, add it to the [issues](https://github.com/NetTopologySuite/GeoAPI/issues), maybe someone already implemented what you need. | ||
- Spread the word: A project like this grows and improves when usage increases and we have more eyes on the code. So spread the word by writing blog posts or tweet about this awesome library! | ||
|
||
### How to contribute? | ||
|
||
First of all don't be afraid to contribute. Most contributions are small but very valuable. Some basic rules to make things easier for everyone: | ||
|
||
- Don't change more than you need to to fix something or implement a new feature. No 'resharping' or refactoring please. | ||
- Think about more than yourself, this may seem strange, but NTS is used in widely different projects. Adding a feature or fixing a bug needs to take all this into account. | ||
- Don't break things, try to fix a bug without changing the API or when adding a feature make sure to add, not remove stuff. If you do need to break things, get in touch by reporting an [issue](https://github.com/NetTopologySuite/GeoAPI/issues). | ||
|
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters