Skip to content

Latest commit

 

History

History
47 lines (24 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

47 lines (24 loc) · 2.55 KB

Contributing

Thank you for your interest in contributing to this project to make it even better!

Not sure where to start? Check out the currently filed issues to see if there's anything there you'd like to work on.

Please ensure first that someone is not already working on an issue. If the issue seems stale or inactive and you want to take it over, get in touch with fernandominguez, the assigned person (check the comments on the issue for whom), or simply comment on the issue asking for status.

Please use the develop branch for your work on this project. Feature and bug branches must be merged back to the develop branch.

Feature requests

The best thing to do here is to file an issue if there already isn't one. If it's something fairly obviously needed (in your opinion) and you are happy to code it, feel free to open a pull request without filing an issue first. You can open a new feature branch if you want, but please use this prefix feature/, for example feature/fix-something.

Bugs / Issues

Run a quick look through the currently open and closed issues and pull requests to make sure it hasn't already been reported or closed. If it's unique, feel free to open an issue. You can open a new bug branch if you want, but please use this prefix bug/, for example bug/fix-something.

Code contribution workflow

  1. Fork this repository and clone the new fork locally.

  2. Run npm install to install the dev dependencies.

  3. Make your changes in a new git branch: git checkout -b my-fix-branch master

  4. Follow the coding style of this project. We base our style on the Google styleguide

  5. Create your patch/feature, including appropriate tests.

  6. Commit your changes using a descriptive commit message.

  7. Rebase on master if your branch falls behind on commits.

  8. Run the local tests via docker-compose up --build to make sure everything is passing.

  9. Push up your new branch to your forked repo.

  10. In GitHub, send a pull request to nodejs-rest-api-boilerplate:master. Include an explanation of what you did, and reference any issues if they are related.

Code of conduct

Please read the code of conduct in the interest of fostering an open and welcoming environment.

Financial contributions

If you think this project is interesting enough, and want to help me by donating some funds to me, you can do it here. Thank you very much for your support!