contributing.md

Contribution Guidelines

Everything here is markdown, which means there are two channels for contributions.

Pull requests: you recognize an enhancement and make it happen, or an issue and fix it, then make a pull request so it's shared with everyone!

Issues: something is wrong/misleading/confusing and you are too lazy to fix it yourself and make a pull request.

Note: pull requests and issues should have a useful title.

Example Contributions

Adding a new data source(s)

Thank you for adding some leaves to this data tree! Please try to be as consistent with the list structure as possible so users can get the most out of it.

Updating an existing source status

As sources become unavailable they should be flagged until they come back online.

Correcting an error

The topics or levels are wrong/misleading/confusing? Lets fix it!

Making a pull request

Never made a pull request before? First you'll need a GitHub account!

Note: the example images below are for a different repo, but the steps are the same.

1. Access the awesome-city-data list's GitHub page: https://github.com/TStesco/awesome-city-data
2. Click on the readme.md file:
3. Now click on the edit icon.
4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown.
5. Say why you're proposing the changes, and then click on "Propose file change".
6. Submit the pull request!

Updating your Pull Request

Sometimes, a maintainer will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your Pull Request didn't match the list guidelines. I will try to review and merge all Pull Requests within 24 hours!

Here is a write up on how to change a Pull Request, and the different ways you can do that.