Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

74 lines (48 loc) · 3.61 KB
Raw

Contributing to my package

Thank you for reading the contribution guidelines of this project. It will help you to make great contributions like reporting issues, creating feature requests, and submitting pull requests.

Issues, Feature Request & Questions

Before submitting bug reports, documentation improvements requests, feature requests, or questions, please do a quick search in Open Issues to verify if it was already created. If there is an existing issue, add your comments to that one.

Writing Great Issues & Feature Requests

  • Provide reproducible steps, what the result of the steps was, and what you expected to happen.
  • Avoid listing multiple bugs or requests in the same issue. Always write a single bug or feature request per issue.
  • Avoid adding your issue as a comment to an existing one unless it's for the same exact input. Issues can look similar, but have different causes.
  • Add screenshots or animated GIFs if needed.

Submitting Issues

  1. Go to the repository page, go to the Issues section, and then click on the New issue button.
  2. Choose the template that fits to your case.
    1. Bug
    2. Documentation improvement request
    3. Feature request
    4. Question
  3. Fill the issue template with the requested information.

Development Guidelines

Branching Model

  • Main: Accepts merges from Features/Issues and Hotfixes

  • Features/Issues: Always branch off from main

    • Prefix: ${action}/*. E.g.: add/git-pre-commit-hooks, fix/eslint-checks

    Actions available: add, update, fix, and remove

  • Hotfix: Always branch off from main

    • Prefix: hotfix/* e.g.: hotfix/failing-config

Contributing

If you are going to contribute to this project, follow the next steps:

  1. Clone the repo.

    git clone https://github.com/totigm/ts-package-template.git

  2. Go to the ts-package-template directory and install the dependencies.

    cd ts-package-template
npm install

  3. Make your great contribution. Like enhancements, updates, hotfixes. Please, remember to follow the branching model

Submit contribution

Pull Requests are a great way to keep track of tasks, enhancements, and bugs for the projects. When we are writing them, we must think about how the rest of the team is going to read it, and what kind of information we will place into it to make it easy to read and understand their changes. Follow these practices to help you to write great pull requests.

Writing great pull requests

In order to follow styling guides and keep the code well formatted, please run the ESLint and Prettier tools before submitting your pull request. You can use the npm run check or yarn check commands to verify warnings and errors. Then, use npm run check:fix or yarn check:fix to fix the auto-fixable errors.

  • Choose a descriptive title and add the context of the changes using brakes.
    • ex: [Feature] Add specific-command-help, [Documentation improvement] Add deployment guide
  • If the pull request fixes an issue:
    • Add the name of the issue as the title.
      • e.g.: ISSUE #008: Fix ESLint checks ---> PR Title: [ISSUE#008] Fix ESLint checks
  • Provide all the information about the changes made in the pull request.
  • Add screenshots or animated GIFs.