Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 4.76 KB

CONTRIBUTING.md

File metadata and controls

77 lines (55 loc) · 4.76 KB
Raw

Welcome to Open World API contribution guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on open-world-api.com

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Make changes locally

  1. Install Git.

  2. Install Node LST

  3. Fork the repository.

  4. On your local machine clone the forked repo

  5. CD into the repo and enter npm i in the terminal

  6. You basically just make changes in a JSON file, make sure to understand what JSON is and how to write JSON.

  7. In your current directory navigate data->countries. Where you will find a list of all the countries available.

  8. Follow the basic JSON format below and you are good to go!!!.

  9. Create a pull request after making changes

Commit your update

Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji's for commit messages.

Once you are ready with your changes, don't forget to self review to quicken the review process ⚡.

Pull Request

When you're done making the changes, open a pull request, often referred to as a PR.

  • Fill out the "Ready for review" template so we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged

Congratulations 🎉🎉 The OpenWorldApi team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the OpenWorldApi.

Now that you are part of the OpenWorldApi community, see how else you can contribute to the docs.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is GDSC-LPU.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.\

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting