Documentation files for github projects

README.md

{{PROJECT_NAME}}

Develop

Requirements

• NodeJS
• Unicorns

Getting Started

1. Install dependencies:

   npm install

2. Start dev server:

   npm start

3. Coding, coding, coding...
4. Lint the project

   npm run lint
   

Contributing

Read CONTRIBUTING.md file.

Credits

• Alberto Fernandez

License

This project is licensed under {{LICENSE_CODE}} license. More info on LICENSE file.

CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

CONTRIBUTING.md

Contribute to this Project

This project uses gitflow, try to use this practice whenever you can.

Define a small phrase for the feature branch like (feature/user-login) and refer to the corresponding issues in your commit messages (Call to API login #123).

When you're done coding create a new PR (Pull Request), you could add a close/fix declaration (closes #123 fix #321) on the PR description to autoclose the related issues on merge.

Note: If the project hasn't any related issue you should create one to refer your commit messages to it.

Bugs & issues

Create one issue for each bug or fix you want to do or group them by functionality. The branch naming convention is bugfix/fix-name (bugfix/login-bugs).

Hotfixes

Develop them in a hotfix branch (hotfix/login) merge it to master by PR and if there is no issue use the PR as your bug issue (tag it with bug).

Pull Requests (PR)

Assign at least one reviewer on your PR, do to not assign them always to the same person and tag them accordingly.

---

❤️ Happy Coding!