Contributing Guidelines

We welcome any contribution to the repo that aims to improve the repository. It is to be noted that contributors should follow the Code of Conduct of the repository while considering any contributions.

Contributors can contribute either working on the current open issues or if they wish can propose new ideas via issues or emails for discussion. We encourage following pull request workflow to create pull requests on issues. For starters, considering following this link to learn more about pull requests.

To develop in this code base, you need to:

  • Go briefly throught the code of conduct

  • Fork this repository in your own github account

  • Clone the repository into your local computer

  • In your terminal run git remote add origin https://github.com/user_name/project_name

  • Also run git remote add upstream https://github.com/prokuranepal/project_name.git

  • Install node dependecies

  • Make changes and create a pull request

  • Update the README.MD file based on new updates considering the libraries used, changes to environment variables, exposed ports and so on

  • Finally the owners of the repo will go through new contributions and approve the changes if seem fit

Contributors are welcome to contribute considering:

  • New features to be added to the repository

  • Bug fixes

  • Improvements to the repository

  • Better coding techniques/practice to replace older code practices

  • Unit/Integration tests

  • Documentation