Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 3.17 KB
Raw

Contributing to the Igbo API

If you have questions about the Igbo API (not a bug report), please ask a question in our Slack community as a volunteer.

Contributions are always welcome. Before contributing please read the Code of Conduct section.

Reporting bugs

Before opening a new issue, look for existing issues to avoid duplication. If the issue does not exist yet, create one.

  • Please post any relevant code samples or screenshots
  • If the bug involves an error, please post the stack trace
  • Please fully detail the nature of the bug by filling out the issue template

Requesting new features

  • Before opening a new issue, look for existing issues to avoid duplication. If the issue does not exist yet, create one.
  • Please fully detail the nature of the feature request by filling out the request template

Areas of contribution

There are plenty of opportunities to support and help maintain this repo. This includes, but is not limited to:

  1. Request new features for the Igbo API
  2. Fixing typos in code or sample/mock data
  3. Update the README or write documentation for implementations
  4. Convert files from JS to TS
  5. So much more...

If you have more ideas of how to improve the Igbo API, reach out to Ijemma on Slack as a volunteer.

Accepting work

Once you find an issue you would like to work on, you can request to have that issue assigned to you to begin work.

Note: Multiple people can be assigned to the same ticket. Issue assignment is only meant to help track who's working on what. This means that multiple contributors can be working on the same issue.

Fork the repo

Please ensure that you fork this repo before making any changes. This will ensure that you are not only able to make changes in your own work environment but also able to submit PRs.

This repo is set up to only accept PRs from forked repos

Pull Request Process

Before Opening a Pull Request

Double-check to make sure that you have done the following things:

  1. If implementing a feature request, create new unit tests to increase confidence in your changes.
    • You're code will be unable to get merged without new unit tests
  2. Check to see if your changes are non-breaking by running npm run test
  3. And install or build dependencies are removed
    • You can run npm run clean to remove unwanted files.
  4. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.

After Opening a Pull Request

  1. Open a pull request and assign at least one reviewer, @ijemmao.
  2. You may merge the pull request in once the following things happen
    • All the tests pass against your branch build
    • You have the sign-off from both reviewers

Coding Style

This project follows the AirBnb JavaScript Style Guide.