From d5e93720f819054b3745ad1471d6e1f20e8e32fc Mon Sep 17 00:00:00 2001 From: m0nac0 <58807793+m0nac0@users.noreply.github.com> Date: Mon, 27 Jul 2020 11:31:15 +0200 Subject: [PATCH] Update CONTRIBUTING.md (#366) --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7a94abbd7..6b6754a9a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,15 +2,14 @@ We welcome contributions to this repository. Please follow these steps if you're interested in making contributions: -1. Please familiarize yourself with the [install process](https://github.com/mapbox/flutter-mapbox-gl#getting-started). - +1. Please familiarize yourself with the [process of running the example app](https://github.com/tobrun/flutter-mapbox-gl#running-the-example-app) and [add a Mapbox access token](https://github.com/tobrun/flutter-mapbox-gl#adding-a-mapbox-access-token) as described in the Readme. 2. Ensure that existing [pull requests](https://github.com/mapbox/flutter-mapbox-gl/pulls) and [issues](https://github.com/mapbox/flutter-mapbox-gl/issues) don’t already cover your contribution or question. -3. Create a new branch that will contain your contributed code and eventually create a pull request once you're done making changes. +3. Create a new branch that will contain your contributed code. Along with your contribution you should also adapt the example app to showcase any new features or APIs you have developed. This also makes testing your contribution much easier. Eventually create a pull request once you're done making changes. 4. If there are any changes that developers should be aware of, please update the [changelog](https://github.com/mapbox/flutter-mapbox-gl/blob/master/CHANGELOG.md) once your pull request has been merged to the `master` branch. # 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](http://contributor-covenant.org) applies to all projects under the Mapbox organization and we ask that you please read [the full text](http://contributor-covenant.org/version/1/2/0/). -You can learn more about our open source philosophy on [mapbox.com](https://www.mapbox.com/about/open/). \ No newline at end of file +You can learn more about our open source philosophy on [mapbox.com](https://www.mapbox.com/about/open/).