Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.42 KB

contributing.md

File metadata and controls

37 lines (24 loc) · 1.42 KB

Contributing

If you've come this far, it's because you're interested in contributing to the library. I'm really glad about it. Thanks. Below you will find more details about the folder structure, branch pattern, and how to make your pull request in the repository.

Fork and Pull Request

  • Fork the thread-tasker repository here
  • Make a clone of your fork on your computer.

Branch

Before you start coding consider the following definitions.

  • Make sure:
    • that you have forked the official thread-tasker repository
    • that you have your fork clone on your computer and that it is synchronized with the official repository.
    • that your 'fork' is up to date with the latest changes from the official repository.
  • New branches must be created from the main branch of your fork.

Branch definitions and prefixes

  • Bug Fixes: bugfix/<your-fixe bug fix

  • New Functionality: development of new feature/<resource> functionalities

  • Refactoring: refactor/<your-refactoring> code refactoring

  • Urgent fixes: hotfix/<your-urgent-fixes> urgent bug fixes

    -> thread-tasker git:(main): git checkout -b <prefix>/<your-definition-name>

End

If you have any questions feel free to open a discussion here.

It's just for now. Thank you for your interest in contributing to this repository.