CONTRIBUTING.md
# Contributing to Turbogit
We would love for you to contribute to Turbogit and help make it even better than it is
today! As a contributor, here are the guidelines we would like you to follow:
## Code of Conduct
Help us keep Turbogit open and inclusive. Please read and follow our [Code of Conduct](/code-of-conduct).
## Got a Question or Problem?
If you have any questions regarding how to use Turbogit or contributing to this repo
please [submit an issue](/contributing#submitting-an-issue) using the **Need help** template.
## Found a Bug?
If you find a bug in the source code, you can help us by
[submitting an issue](/contributing#submitting-an-issue) using the **Bug report** template. Even better, you can
[submit a Pull Request](/contributing#submitting-a-pull-request) with a fix.
## Missing a Feature?
You can *request* a new feature by [submitting an issue](/contributing#submitting-an-issue) to our GitHub
Repository using the **Feature request** template. If you would like to *implement* a new feature, please submit an issue with
a proposal for your work first, to be sure that we can use it.
Please consider what kind of change it is:
* For a **Major Feature**, first open an issue and outline your proposal so that it can be
discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
and help you to craft the change so that it is successfully accepted into the project.
* **Small Features** can be crafted and directly [submitted as a Pull Request](/contributing#submitting-a-pull-request).
## Submission Guidelines
### Submitting an Issue
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, please fill the *To Reproduce* section when possible.
Having a reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like:
- version of Turbogit used
- general system information
- and most importantly - a use-case that fails
A minimal reproduce scenarion allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem.
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.
You can file new issues by filling out our [new issue form](https://github.com/b4nst/turbogit/issues/new/choose) using the **Bug report** template.
### Submitting a Pull Request
Before you submit your Pull Request (PR) consider the following guidelines:
1. Search [GitHub](https://github.com/angular/angular/pulls) for an open or closed PR
that relates to your submission. You don't want to duplicate effort.
1. Fork the b4nst/turbogit repo.
1. Make your changes in a new git branch:
```shell
git checkout -b my-fix-branch main
```
1. Create your patch, **including appropriate test cases**.
1. Follow our [Coding Rules](/contributing#coding-rules).
1. Commit your changes using a descriptive commit message that follows our
[commit message conventions](/contributing#commit-message-format). Adherence to these conventions
is necessary because release notes will be automatically generated from these messages (eventually).
```shell
tug commit
```
1. Push your branch to GitHub:
```shell
git push origin my-fix-branch
```
1. In GitHub, send a pull request to `turbogit:main`.
* If we suggest changes, or the ci fail then:
* Make the required updates.
* Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
```shell
git rebase main -i
git push -f
```
That's it! Thank you for your contribution!
#### After your pull request is merged
After your pull request is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository:
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```shell
git push origin --delete my-fix-branch
```
* Check out the main branch:
```shell
git checkout main -f
```
* Delete the local branch:
```shell
git branch -D my-fix-branch
```
* Update your main with the latest upstream version:
```shell
git pull --ff upstream main
```
## Coding Rules
To ensure consistency throughout the source code, keep these rules in mind as you are working:
* All features or bug fixes **must be tested** by one or more specs (unit-tests).
* All commands **must be documented** using cobra generated documentation.
## Commit Message Guidelines
We follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for out commit messages. This leads to **more
readable messages** that are easy to follow when looking through the **project history**.
### Commit Message Format
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
format that includes a **type**, a **scope** and a **subject**:
```
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
```
The **header** is mandatory and the **scope** of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
to read on GitHub as well as in various git tools.
Samples: (even more [samples](https://github.com/angular/angular/commits/main))
```
docs(changelog): update changelog to beta.5
```
```
fix: bug in commit command
```
### Revert
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
### Type
Must be one of the following:
* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
* **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
* **docs**: Documentation only changes
* **feat**: A new feature
* **fix**: A bug fix
* **perf**: A code change that improves performance
* **refactor**: A code change that neither fixes a bug nor adds a feature
* **revert**: Revert commit
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
* **test**: Adding missing tests or correcting existing tests
### Scope
The scope should be the name of command affected, if any.
e.g.:
- branch
- commit
- config
### Subject
The subject contains a succinct description of the change:
* use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize the first letter
* no dot (.) at the end
### Body
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
The body should include the motivation for the change and contrast this with previous behavior. The body is optional.
### Footer
The footer is the place to reference GitHub issues that this commit **Closes**. The footer is optional