CONTRIBUTING.md

Contributing to the NovelCOVID API

Thanks for taking your time to consider contributing to the project! In this file, you are going to find helpful tips on how to contribute your ideas!

We try to make contributing as easy and transparent as possible, whether it's:

• Reporting a bug

• Discussing the current state of the code

• Submitting a fix

• Proposing new features

Testing

We have a handful of unit tests to cover most of the APIs functionality. Please always create tests for your code additions so we can easily see if your code works as expected.

Submitting changes

• If you're unable to find an open issue, open a new one. Be sure to include a title, a clear description of your idea or issue and give as much relevant information as possible.
• Open a new GitHub Pull Request to API with a clear list of what you've done (read more about pull requests). Include the relevant issue number if applicable.

Unsure where to begin contributing? You can start by looking through these issues labels:

• Enhancement issues
• Bug issues
• Documentation issues

To submit a project (Dashboards, Mobile Applications, Desktop Applications, Bots, Wrappers,... etc) using the NovelCOVID API, head over to our awesome-novelcovid list.

Use a Consistent Coding Style

• Please use npm run lint for style unification

See Installation section for further instructions.

Thanks! ❤️ ❤️ ❤️

NovelCOVID API Team