Skip to content

Commit 14843cc

Browse files
committed
docs: Fixing typos and updating information
New git commands and contact information
1 parent f573183 commit 14843cc

5 files changed

Lines changed: 46 additions & 45 deletions

File tree

.github/getting-started.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In this part, you will configure your project.
1010

1111
### Branches
1212

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.
1414

1515
For each of the following branches, add the required protections.
1616

@@ -35,14 +35,14 @@ This template provides the must-have documents.
3535

3636
The README.md is the showcase of your project. It always must be clean and consistent. Otherwise, no one will care of your project.
3737

38-
Fill every sections of the [README.md](../README.md).
38+
Fill every sections of the [README.md](/README.md).
3939
> If you add pictures, put them in the [assets](./assets/) folder.
4040
4141
#### CONTRIBUTING.md
4242

4343
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.
4444

45-
Fill every sections of the [CONTRIBUTING.md](../CONTRIBUTING.md).
45+
Fill every sections of the [CONTRIBUTING.md](/CONTRIBUTING.md).
4646

4747
#### LICENSE
4848

@@ -51,7 +51,7 @@ The LICENSE protects your code and contributors.
5151
This template provides an [Apache Licence 2.0](https://www.apache.org/licenses/LICENSE-2.0).
5252
> If you want another one, check this [guide](https://choosealicense.com).
5353
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).
5555

5656
### About
5757

@@ -75,7 +75,7 @@ Change the default assignee of the [feature_request](./ISSUE_TEMPLATE/feature_re
7575

7676
#### Pull Requests
7777

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.
7979

8080
This template provides a [pull request template](./pull_request_template.md). You don't need to update it.
8181

@@ -91,20 +91,20 @@ A label helps to categorize issues and pull requests.
9191

9292
Make sure to have the following labels :
9393

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
108108

109109
### GitHub project
110110

@@ -136,7 +136,7 @@ A task is associated as an issue.
136136

137137
### Workflow
138138

139-
The workflow to follow is :
139+
The workflow to follow is:
140140

141141
1) Create a milestone
142142
2) Create all the needed issues linked to this milestone
@@ -151,11 +151,11 @@ Each milestones must use the [milestone template](./milestone_template.md).
151151

152152
There are two parts :
153153
- 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 ⚠️**
155155
- 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 ⚠️**
157157
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!
159159

160160
### Issues
161161

@@ -175,7 +175,7 @@ You can discuss in a pull request, do it as much as you can!
175175

176176
**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.**
177177

178-
It is a powerfull tool, use it well!
178+
It is a powerful tool, use it well!
179179

180180
### Releases
181181

@@ -187,7 +187,7 @@ Tag pull requests with the `patch`, `minor` or `major` labels.
187187

188188
### Discord Webhook
189189

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.
191191

192192
Follow this [tutorial](https://gist.github.com/SGTGunner/50d6a3cc0d489cf779f77695ba3e22ea).
193193

@@ -199,6 +199,6 @@ Follow this [tutorial](https://docs.github.com/en/code-security/dependabot/depen
199199

200200
### Help
201201

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).
203203

204-
> Made with :heart: by PoC
204+
> Made with ❤️ by PoC

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Please complete this section if any breaking changes have been made, otherwise d
2222
- [ ] I have linked this PR to a milestone
2323
- [ ] I have linked this PR to a project
2424
- [ ] I have tested this code
25-
- [ ] I have added / updated tests (unit / functionals / end-to-end / ...)
25+
- [ ] I have added / updated tests (unit / functional / end-to-end / ...)
2626
- [ ] I have updated the README and other relevant documents (guides...)
2727
- [ ] I have added sufficient documentation both in code, as well as in the READMEs
2828

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Create an issue
44

55
- 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=).
77

88
## Resolve an issue
99

@@ -29,7 +29,7 @@ git remote add <fork_name> https://github.com/$YOUR_GITHUB_USER/$REPOSITORY.git
2929

3030
```sh
3131
# Create a new branch
32-
git checkout -b my_branch
32+
git switch -c my_branch
3333

3434
# Make changes to your branch
3535
# ...
@@ -46,14 +46,14 @@ git push <fork name>
4646
### 3. Update your pull request with latest changes
4747

4848
```sh
49-
# Checkout main branch
50-
git checkout main
49+
# Switch to the main branch
50+
git switch main
5151

5252
# Pull origin's change
5353
git pull
5454

55-
# Checkout your branch
56-
git checkout my_branch
55+
# Switch to your branch
56+
git switch my_branch
5757

5858
# Rebase your branch changes on top of the updated main branch
5959
git rebase main
@@ -69,7 +69,7 @@ git push -f <fork name>
6969
Contributions to this project must be accompanied by a Developer Certificate of
7070
Origin (DCO).
7171

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:
7373

7474
```sh
7575
git commit -s
@@ -109,4 +109,4 @@ Then, follow these guidelines:
109109
- `chore:` general things that should be excluded (e.g., `chore: Clean up X`);
110110
- `ci:` for internal CI specific changes (e.g., `ci: Enable X for tests`);
111111

112-
> Made with :heart: by PoC
112+
> Made with ❤️ by PoC

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [2022] [PoC Innovation]
189+
Copyright [2023] [PoC Innovation]
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ You're invited to join this project ! Check out the [contributing guide](./CONTR
2828

2929
If you're interested in how the project is organized at a higher level, please contact the current project manager.
3030

31-
## Our PoC team :heart:
31+
## Our PoC team ❤️
3232

3333
Developers
3434
| [<img src="https://github.com/MrZalTy.png?size=85" width=85><br><sub>[Developer's name]</sub>](https://github.com/MrZalTy) | [<img src="https://github.com/MrZalTy.png?size=85" width=85><br><sub>[Developer's name]</sub>](https://github.com/MrZalTy) | [<img src="https://github.com/MrZalTy.png?size=85" width=85><br><sub>[Developer's name]</sub>](https://github.com/MrZalTy)
@@ -44,24 +44,25 @@ Organization
4444

4545
<p align='center'>
4646
<a href="https://www.linkedin.com/company/pocinnovation/mycompany/">
47-
<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white">
47+
<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" alt="LinkedIn logo">
4848
</a>
4949
<a href="https://www.instagram.com/pocinnovation/">
50-
<img src="https://img.shields.io/badge/Instagram-E4405F?style=for-the-badge&logo=instagram&logoColor=white">
50+
<img src="https://img.shields.io/badge/Instagram-E4405F?style=for-the-badge&logo=instagram&logoColor=white" alt="Instagram logo"
51+
>
5152
</a>
5253
<a href="https://twitter.com/PoCInnovation">
53-
<img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white">
54+
<img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" alt="Twitter logo">
5455
</a>
5556
<a href="https://discord.com/invite/Yqq2ADGDS7">
56-
<img src="https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white">
57+
<img src="https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white" alt="Discord logo">
5758
</a>
5859
</p>
5960
<p align=center>
6061
<a href="https://www.poc-innovation.fr/">
61-
<img src="https://img.shields.io/badge/WebSite-1a2b6d?style=for-the-badge&logo=GitHub Sponsors&logoColor=white">
62+
<img src="https://img.shields.io/badge/WebSite-1a2b6d?style=for-the-badge&logo=GitHub Sponsors&logoColor=white" alt="Website logo">
6263
</a>
6364
</p>
6465
65-
> :rocket: Don't hesitate to follow us on our different networks, and put a star 🌟 on `PoC's` repositories
66+
> 🚀 Don't hesitate to follow us on our different networks, and put a star 🌟 on `PoC's` repositories
6667
67-
> Made with :heart: by PoC
68+
> Made with ❤️ by PoC

0 commit comments

Comments
 (0)