Skip to content

Commit

Permalink
docs: update branch conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
hamed-shirbandi authored Oct 10, 2023
1 parent cd16c6d commit 19b1a58
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/Branch-Conventions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# Feature Branch Workflow
We use [feature branching](https://martinfowler.com/bliki/FeatureBranch.html) to work on new features or tasks in our open-source project. Each feature or task gets its own separate branch in our code. This helps us develop and test things without messing up the main code. Once a feature is done and tested, we merge it back into the main code. It keeps our work organized, lets us work together, and makes it easier to handle multiple tasks at once.

# Contribution Guide: Using Feature Branches
1- Create a branch in line with our Branch Naming Conventions.
2- Check out the branch on your local environment (e.g., Visual Studio).
3- Commit your changes following our commit conventions.
4- Push your commits and submit a Pull Request from your fork to the Taskomask master branch.
5- Our team will review your code and gladly welcome you as a contributor!

# Branch Naming Conventions
Branch name should be structured as follows:
Expand Down Expand Up @@ -31,4 +40,4 @@ Issue Id related to the branch.
```
fix-26-prevent-inactive-user-login
```
```

0 comments on commit 19b1a58

Please sign in to comment.