Skip to content

Latest commit

 

History

History
39 lines (33 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

39 lines (33 loc) · 1.51 KB

Contributing

Information About Contributing to Project

Create Issues

  • If you find something missing or something is wrong in this manual, you are welcome to write an issue describing the problem.
  • If you can, please try to fix the problem yourself.
  • For minor changes, it is not necessary to create an issue first.

Make changes (create pull requests)

In order to make changes

  1. Fork the repository
  2. Install neded dependencies. This step is important to install husky scripts responsible for verifying your code before push
    yarn install
  3. In your forked repository, make your changes in a new git branch:
    git checkout -b my-fix-branch master
  4. Make your changes and add documentation if needed
  5. Commit your changes using a descriptive commit message that follows conventional commits conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.
    • Please include issue number.
    • If your changes includes breaking changes, please describe it.
    • Example:
    git commit -m "fix: eslint issues (#169)"
  6. Push your branch to GitHub:
    git push origin my-fix-branch
  7. In GitHub, send a pull request to nuxt-typo3:develop
  8. Thank you 👏