Skip to content

Commit

Permalink
Merge pull request #130 from Crypto-TII/fix/fix-contributing-file
Browse files Browse the repository at this point in the history
Fix CONTRIBUTING.md links.
  • Loading branch information
peacker authored Jan 25, 2024
2 parents 9e9048c + b39b6f4 commit 0af6ab7
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ To contribute to this project, please, follow the following conventions.
- [Contributing to the documentation](#contributing-to-the-documentation)
- [Project structure](#project-structure)
- [GIT Conventions](#git-conventions)
- [Branches](#branches)
- [Pull Requests](#pull-requests)
- [Branches conventions](#branches-conventions)
- [Pull Requests conventions](#pull-requests-conventions)
- [Best practices for development](#best-practices-for-development)
- [Linter/Formatter](#linterformatter)
- [Imports](#imports)
Expand Down Expand Up @@ -472,15 +472,15 @@ This is the current project structure.
```

# GIT Conventions
## Branches
## Branches Conventions
- `main` is the main branch.
- `develop` is the branch where the latest changes are merged into.
- `<fix|feature|breaking>/<task-name>` is the branch where a new feature is developed.

> ⚠️ We encourage you to follow this convention when creating new branches even though branches with the naming
> convention `<task-name>` are allowed. ⚠️
## Pull Requests
## Pull Requests Conventions
- Pull Requests should be made from a `feature-branch` to `develop` and it should be reviewed by at least one person.
- New branches to development tasks will have `develop` branch as origin.
- The only allowed Pull Requests to `main` branch must come from `develop` branch. All other Pull Requests will be
Expand Down

0 comments on commit 0af6ab7

Please sign in to comment.