You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/getting-started.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ In this part, you will configure your project.
10
10
11
11
### Branches
12
12
13
-
Branch protection is really important. It helps you to have controle on your code.
13
+
Branch protection is really important. It helps you to have control on your code.
14
14
15
15
For each of the following branches, add the required protections.
16
16
@@ -35,14 +35,14 @@ This template provides the must-have documents.
35
35
36
36
The README.md is the showcase of your project. It always must be clean and consistent. Otherwise, no one will care of your project.
37
37
38
-
Fill every sections of the [README.md](../README.md).
38
+
Fill every sections of the [README.md](/README.md).
39
39
> If you add pictures, put them in the [assets](./assets/) folder.
40
40
41
41
#### CONTRIBUTING.md
42
42
43
43
The CONTRIBUTING.md is the guide to contribute to your project. It always must be clean and consistent. Otherwise, no one will contribute to your project.
44
44
45
-
Fill every sections of the [CONTRIBUTING.md](../CONTRIBUTING.md).
45
+
Fill every sections of the [CONTRIBUTING.md](/CONTRIBUTING.md).
46
46
47
47
#### LICENSE
48
48
@@ -51,7 +51,7 @@ The LICENSE protects your code and contributors.
51
51
This template provides an [Apache Licence 2.0](https://www.apache.org/licenses/LICENSE-2.0).
52
52
> If you want another one, check this [guide](https://choosealicense.com).
53
53
54
-
If your project doesn't belong to [PoC Innovation](https://github.com/PoCInnovation), make sure to update the copyrights of the [LICENCE](../LICENSE).
54
+
If your project doesn't belong to [PoC Innovation](https://github.com/PoCInnovation), make sure to update the copyrights of the [LICENCE](/LICENSE).
55
55
56
56
### About
57
57
@@ -75,7 +75,7 @@ Change the default assignee of the [feature_request](./ISSUE_TEMPLATE/feature_re
75
75
76
76
#### Pull Requests
77
77
78
-
A pull request is an event where a contributor asks a maintener to review code.
78
+
A pull request is an event where a contributor asks a maintainer to review code.
79
79
80
80
This template provides a [pull request template](./pull_request_template.md). You don't need to update it.
81
81
@@ -91,20 +91,20 @@ A label helps to categorize issues and pull requests.
91
91
92
92
Make sure to have the following labels :
93
93
94
-
-`bug`: Something isn't working
95
-
-`bugfix`: Resolve a bug
96
-
-`chore`: Global maintenance
97
-
-`documentation`: Improvements or additions to documentation
98
-
-`duplicate`: This issue or pull request already exists
99
-
-`enhancement`: New feature or request
100
-
-`help wanted`: Extra attention is needed
101
-
-`invalid`: This doesn't seem right
102
-
-`major`: Major update (for release)
103
-
-`minor`: Minor update (for release)
104
-
-`patch`: Patch update (for release)
105
-
-`question`: Further information is requested
106
-
-`triage`: Need to be tagged
107
-
-`wontfix`: This will not be worked on
94
+
-`bug`: Something isn't working
95
+
-`bugfix`: Resolve a bug
96
+
-`chore`: Global maintenance
97
+
-`documentation`: Improvements or additions to documentation
98
+
-`duplicate`: This issue or pull request already exists
99
+
-`enhancement`: New feature or request
100
+
-`help wanted`: Extra attention is needed
101
+
-`invalid`: This doesn't seem right
102
+
-`major`: Major update (for release)
103
+
-`minor`: Minor update (for release)
104
+
-`patch`: Patch update (for release)
105
+
-`question`: Further information is requested
106
+
-`triage`: Need to be tagged
107
+
-`wontfix`: This will not be worked on
108
108
109
109
### GitHub project
110
110
@@ -136,7 +136,7 @@ A task is associated as an issue.
136
136
137
137
### Workflow
138
138
139
-
The workflow to follow is:
139
+
The workflow to follow is:
140
140
141
141
1) Create a milestone
142
142
2) Create all the needed issues linked to this milestone
@@ -151,11 +151,11 @@ Each milestones must use the [milestone template](./milestone_template.md).
151
151
152
152
There are two parts :
153
153
- Overall
154
-
> **:warning: It's checklist must be completed before starting this sprint :warning:**
154
+
> **⚠️ It's checklist must be completed before starting this sprint ⚠️**
155
155
- Final Report
156
-
> **:warning: It's checklist must be completed before starting a new sprint :warning:**
156
+
> **⚠️ It's checklist must be completed before starting a new sprint ⚠️**
157
157
158
-
Additional informations are written in the milestones's checklists. Read them carefully!
158
+
Additional information is written in the milestones's checklists. Read them carefully!
159
159
160
160
### Issues
161
161
@@ -175,7 +175,7 @@ You can discuss in a pull request, do it as much as you can!
175
175
176
176
**No tasks (issue) must be created directly from the GitHub project. Create an issue using a template, it will automatically appears on the GitHub project. Don't forget to archive the tasks once the milestone is closed.**
177
177
178
-
It is a powerfull tool, use it well!
178
+
It is a powerful tool, use it well!
179
179
180
180
### Releases
181
181
@@ -187,7 +187,7 @@ Tag pull requests with the `patch`, `minor` or `major` labels.
187
187
188
188
### Discord Webhook
189
189
190
-
We strongly advice you to have a discord channel on wich you will receive GitHub updates on your project.
190
+
We strongly advice you to have a discord channel on which you will receive GitHub updates on your project.
191
191
192
192
Follow this [tutorial](https://gist.github.com/SGTGunner/50d6a3cc0d489cf779f77695ba3e22ea).
193
193
@@ -199,6 +199,6 @@ Follow this [tutorial](https://docs.github.com/en/code-security/dependabot/depen
199
199
200
200
### Help
201
201
202
-
If you have any questions, please contact [Adrien Fort](https://github.com/adrienfort).
202
+
If you have any questions, please contact [Reza Rahemtola](https://github.com/RezaRahemtola).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
## Create an issue
4
4
5
5
- If you've encountered a bug, open a [Bug Report](https://github.com/PoCInnovation/$REPOSITORY/issues/new?assignees=&labels=&template=bug_report.md&title=).
6
-
- If you want [PROJECT'S NAME] to have a new fonctionality, open a [Feature Request](https://github.com/PoCInnovation/$REPOSITORY/issues/new?assignees=&labels=&template=feature_request.md&title=).
6
+
- If you want [PROJECT'S NAME] to have a new functionality, open a [Feature Request](https://github.com/PoCInnovation/$REPOSITORY/issues/new?assignees=&labels=&template=feature_request.md&title=).
### 3. Update your pull request with latest changes
47
47
48
48
```sh
49
-
#Checkout main branch
50
-
git checkout main
49
+
#Switch to the main branch
50
+
git switch main
51
51
52
52
# Pull origin's change
53
53
git pull
54
54
55
-
#Checkout your branch
56
-
git checkout my_branch
55
+
#Switch to your branch
56
+
git switch my_branch
57
57
58
58
# Rebase your branch changes on top of the updated main branch
59
59
git rebase main
@@ -69,7 +69,7 @@ git push -f <fork name>
69
69
Contributions to this project must be accompanied by a Developer Certificate of
70
70
Origin (DCO).
71
71
72
-
All commit messages must contain the Signed-off-by line with an email address that matches the commit author. When commiting, use the `--signoff` flag:
72
+
All commit messages must contain the Signed-off-by line with an email address that matches the commit author. When committing, use the `--signoff` flag:
73
73
74
74
```sh
75
75
git commit -s
@@ -109,4 +109,4 @@ Then, follow these guidelines:
109
109
-`chore:` general things that should be excluded (e.g., `chore: Clean up X`);
110
110
-`ci:` for internal CI specific changes (e.g., `ci: Enable X for tests`);
0 commit comments