Skip to content

Commit cf41531

Browse files
committed
feat(contribution-guidelines): add forking and branching structure
1 parent 57b3316 commit cf41531

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

bun.lockb

0 Bytes
Binary file not shown.

pages/contribution-guidelines.mdx

+12-7
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,7 @@ import { Button, Callout, Steps } from 'nextra/components'
55
We're glad that you are interested in contributing to Amigrant. Here are few guidelines and conventions to have a clean and structured codebase.
66
Please take a moment to read through them!
77

8-
## Workflow
9-
10-
We are using a mix of [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), [Github flow](https://docs.github.com/en/get-started/using-github/github-flow) and [Forking workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow)
11-
The upstream has 2 branches, `main` and `develop`. The main branch will not be used for any active development rather it'll act as a [`release-branch`](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow#:~:text=Release%20branches,-Once%20develop%20has&text=Creating%20this%20branch%20starts%20the,tagged%20with%20a%20version%20number) i.e the development will be carried out on `develop` branch(obviously) and the project maintainer will merge `develop` branch into `main` after the release cycle has been completed.
12-
13-
To fork a project follow these steps.
8+
Follow these steps to contribute!
149

1510
<Steps>
1611

@@ -38,13 +33,23 @@ Now, from the [project list](), fork a project that you want to contribute to!
3833
2. Now click on `create fork` Button.
3934

4035
![fork tab](/images/contribution-guidelines/fork-tab.png)
36+
37+
### Start working!
38+
39+
Now you can start working on the `issue`!
40+
41+
> Refer to [Branching structure](#branching-structure) to understand how branches are managed in this project.
4142
4243
</Steps>
4344

44-
## Branching structure
45+
## Branching structure
46+
47+
We are using a mix of [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), [Github flow](https://docs.github.com/en/get-started/using-github/github-flow) and [Forking workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow)
48+
The upstream has 2 branches, `main` and `develop`. The main branch will not be used for any active development rather it'll act as a [`release-branch`](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow#:~:text=Release%20branches,-Once%20develop%20has&text=Creating%20this%20branch%20starts%20the,tagged%20with%20a%20version%20number) i.e the development will be carried out on `develop` branch(obviously) and the project maintainer will merge `develop` branch into `main` after the release cycle has been completed.
4549

4650
![branching structure](/images/contribution-guidelines/branching-structure.png)
4751

52+
4853
## Conventions
4954

5055
### Conventional commits

pages/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The project's documentation will be generated using [Nextra.js](https://nextra.s
5353
> Tech stack is up for discussion i.e it can be changed since the project is in infant stage.
5454
5555
- Data extraction: NER or langchain.
56-
- Fontend: Next.js, shadcn/UI and custom CSS.
56+
- Frontend: Next.js, shadcn/UI and custom CSS.
5757
- Backend: go-amizone SDK and [Gin](https://gin-gonic.com/).
5858
- Testing: respective testing frameworks.
5959
- Documentation: Nextra.js

0 commit comments

Comments
 (0)