Skip to content
This repository has been archived by the owner on Nov 25, 2019. It is now read-only.

Latest commit

 

History

History
35 lines (18 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

35 lines (18 loc) · 1.91 KB

Contributing code

If you want to contribute code:

  1. Ensure that existing pull requests and issues don’t already cover your contribution or question.

  2. Pull requests are gladly accepted. We require code reviews before merging PRs. When your tests pass, tag a project contributor (for example, @tmpsantos or @BergWerkGIS) and request a review.

Requirements and installation

Mac OS

Use Mono to compile the SDK and to run executables. Xamarin Studio is the recommended IDE.

Linux

Coming soon.

Windows

Coming soon.

Running tests

Tests are located in test/UnitTest. On Linux or a mac run them with Mono, mono packages/NUnit.ConsoleRunner.3.5.0/tools/nunit3-console.exe bin/Debug/test/Mapbox.UnitTest.dll or from within your IDE of choice. Tests require a valid MAPBOX_ACCESS_TOKEN env variable in order to pass. Get a MAPBOX_ACCESS_TOKEN by logging into Mapbox Studio.

Generating documentation

Documentation for the the Mapbox SDK C# is automatically generated from XML headers in code. Instructions for generating documentation are coming soon.

Code of conduct

Everyone is invited to participate in Mapbox’s open source projects and public discussions: we want to create a welcoming and friendly environment. Harassment of participants or other unethical and unprofessional behavior will not be tolerated in our spaces. The Contributor Covenant applies to all projects under the Mapbox organization and we ask that you please read the full text.

You can learn more about our open source philosophy on mapbox.com.