Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (26 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

32 lines (26 loc) · 1.87 KB

Contribution Guidelines

Please ensure your pull request adheres to the following guidelines:

  • Make an individual pull request for each suggestion.
  • Titles should be capitalized.
  • Make titles descriptive i.e. not Updated README.
  • Use the following format: [Cool JSON Data Set](link)
  • Link additions should be added to the bottom of the relevant category.
  • New categories or improvements to the existing categorization are welcome.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • Run npm test to check for trailing whitespace (optional)
  • The pull request and commit should have a useful title.

Thank you for your suggestions!

How to contribute from GitHub.com

  • Make sure you have a free GitHub.com account and you are logged in.
  • Find a link to a .json dataset to add. The link should take you to a JSON (JavaScript Object Notation) formatted piece of data.
  • Find an appropriate topic category in the README.md file to add it under, or add your own.
  • Click the 📝 button Edit link on the top right-hand corner of the README.md. This will do two things: 1) Fork the repository to your account, 2) Create a new branch so you can send your changes in a pull request.
  • Add the link in this format: [Cool JSON Data Set](link)
  • Scroll down to the Propose file change box and write a commit message and optional extended description.
  • Click the Propose file change button.

How to set up and run tests from the command line

  • cd awesome-json-datasets
  • npm install
  • npm test

Questions? Stuck with an error message? Make an Issue and we will help you out as best we can!