Skip to content
This repository has been archived by the owner on Jun 22, 2023. It is now read-only.

Commit

Permalink
Added CONTRIBUTING guidelines, LICENSE file and icon. Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
xivk committed Aug 20, 2017
1 parent 2213657 commit c195de0
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 3 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
@@ -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 added LICENSE.md
Empty file.
7 changes: 4 additions & 3 deletions README.md
@@ -1,8 +1,11 @@
[![Travis](https://travis-ci.org/NetTopologySuite/GeoAPI.svg?branch=master)](https://travis-ci.org/NetTopologySuite/GeoAPI)
[![LGPL licensed](https://img.shields.io/badge/license-LGPL-blue.svg)](https://github.com/NetTopologySuite/GeoAPI/blob/develop/LICENSE.md)

- GeoAPI: [![NuGet](https://img.shields.io/nuget/v/GeoAPI.svg?style=flat)](https://www.nuget.org/packages/GeoAPI/))

# GeoAPI

GeoAPI.NET project provides a common framework based on OGC/ISO standards to improve interoperability among .NET GIS projects. GeoAPI is used mostly as a base for [NTS](https://github.com/NetTopologySuite/NetTopologySuite/)
GeoAPI project provides a common framework based on OGC/ISO standards to improve interoperability among .NET GIS projects. GeoAPI is used mostly as a base for [NTS](https://github.com/NetTopologySuite/NetTopologySuite/)

### Supported platforms

Expand All @@ -22,5 +25,3 @@ GeoAPI supports a wide range of .NET versions:

Because of the wide support of platforms, building GeoAPI can be a pain. Make sure you install all the targeting packs. We provided a few scripts for this in the root folder of this repo.

https://github.com/NetTopologySuite/NetTopologySuite/

Binary file added icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c195de0

Please sign in to comment.