Skip to content

Latest commit

 

History

History
55 lines (46 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

55 lines (46 loc) · 4.14 KB
Raw

Contributing to this repository

Getting started

Before you begin

Various ways to contribute

You can contribute to the REANCare service by -

  1. Testing the repository and add additional test cases.
  2. Raising an issue- for a problem you have encountered or for a new feature you want to have.
  3. Fixing the bug or implementing a new feature/part of the feature.
  4. Adding Postman requests and test cases.
  5. Documentation and translation.
  6. Spreading the word!

  • 🪲 Add an issue

    • Issues are used to track the tasks. If you find any problem, a behaviour to be updated, or a new feature to be added, search the issue list if it already has been reported by somebody else. If not, open the issue using the issue template. You can track the progress on the issue or the discuss details in the conversation.

  • 🛠️ Fix the bug/Implement a feature/Create Pull requests

    • If you find any open issues which you think you can contribute to, pick the issue.
    • Create a new branch and clone the repository. You can also fork the repo. See here to see how to set-up development environment on your local machine.
    • Start working on the issue on your machine.
    • Once the issue is resolved locally or a new feature is implemented, test it locally.
    • Perform a self review. Here is the checklist for the self-review.
      • Pull the latest code from the branch against which you are going to merge your the code. This will avoid merging issues later.
      • Confirm that the changes made by you meet the resolution criteria and nothing else.
      • Do not try to solve multiple major issues through a single pull request. Keep it simple, one issue-one pull request.
      • Make sure you have run all the tests locally to check that you have not introduced any new regression.
      • Make sure you are following coding and styling guidelines.
      • Make sure that you change is not overly complex, unreadable and unnecessarily smart. Simplicity wins!
      • Make sure the comments are not too verbose and not to cryptic.
      • If there are any failing tests, fix them first.
      • If there are database schema changes, please make sure that incremental schema changes/migrations are tested locally. Submit your migrations as part of the pull request.
      • Make sure the code metrics are not deteriorated.
      • Make sure you have updated (if necessary)-
        • Documentation
        • Tests/test data
        • Postman collection
        • Version
    • Once satisfied, create a pull request from your branch to designated featue branch.
    • Fill out all the fields in the pull request as per the template. This will help the reviewers to understand your changes.
    • If the reviewer suggests some changes and asks for the clarification, you have to complete those changes.
    • Once the review is satisfactory, the reviewer will merge your changes. If there are again some merge conflicts during merging, you have to resolve those merge conflicts first locally and again push your changes.

For more information, check Coding Style and Guidelines and Checklist to add new API or model.

  • 📝 Document the API
    • REANCare service API is currently documented through Postman as a part of request collection. If you feel that there is a need to update the documentation, open the Postman collection on your machine, update the documentation and save the updated Postman collection.
    • For more information about documenting an API in Postman, please refer Documenting your API.