Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 3.17 KB
Raw

Contributing

So, you're thinking about contributing to NetTopologySuite aka NTS. Awesome!

We welcome contributions and these guidelines are there to help you do just that!

What's this NTS?

NTS intends to be a direct port of the JTS Topology Suite for .NET. While porting we .Net-ify by using e.g. properties or indexers instead of Java get_ and set_(_) methods and so on.

So what does this mean for contributing to NTS?

These projects are directly in sync with NTS:

  • NetTopologySuite

We can't accept changes in behaviour of the core project(s) because we want to keep in sync with JTS, that being said, if you find a bug please fix it and submit a pull-request! We can also accept extra non-breaking functionalty.

All other projects are maintained by us and anything is possible there, these are some examples:

  • NetTopologySuite.IO.TopoJson
  • NetTopologySuite.IO.GeoJson
  • (more here)

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 usecases 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.
  • Follow the capitalization convention in .NET
  • Document your code
    • All classes have code documentation.
    • All public or protected methods, functions and properties have sufficient code documentation
  • Verfiy that the code works as expected by providing adequate unit tests.
  • Upon issueing a pull-request, you need to sign this contributor license agreement

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. We need to know!
  • Bug fixes: Even better, if you can fix something, please do!
  • Feature requests: Need something that's not there, add it to the 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!
  • Make sure to add a test or regression test when you add new features or fix an issue.