|
| 1 | +# Getting Started |
| 2 | + |
| 3 | +> [PoC Innovation's Open-Source project template](https://github.com/PoCInnovation/open-source-project-template) |
| 4 | +
|
| 5 | +Please read carefully this guide. |
| 6 | + |
| 7 | +## Setup |
| 8 | + |
| 9 | +In this part, you will configure your project. |
| 10 | + |
| 11 | +### Branches |
| 12 | + |
| 13 | +Branch protection is really important. It helps you to have control on your code. |
| 14 | + |
| 15 | +For each of the following branches, add the required protections. |
| 16 | + |
| 17 | +#### `main` |
| 18 | + |
| 19 | +```markdown |
| 20 | +- [x] Require a pull request before merging |
| 21 | + - [x] Require approvals |
| 22 | + Required number of approvals before merging: 1 |
| 23 | + |
| 24 | +- [x] Require status checks to pass before merging |
| 25 | + - [x] Require branches to be up to date before merging |
| 26 | + |
| 27 | +- [x] Require conversation resolution before merging |
| 28 | +``` |
| 29 | + |
| 30 | +### Documents |
| 31 | + |
| 32 | +This template provides the must-have documents. |
| 33 | + |
| 34 | +#### README.md |
| 35 | + |
| 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 | + |
| 38 | +Fill every sections of the [README.md](/README.md). |
| 39 | +> If you add pictures, put them in the [assets](./assets/) folder. |
| 40 | +
|
| 41 | +#### CONTRIBUTING.md |
| 42 | + |
| 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 | + |
| 45 | +Fill every sections of the [CONTRIBUTING.md](/CONTRIBUTING.md). |
| 46 | + |
| 47 | +#### LICENSE |
| 48 | + |
| 49 | +The LICENSE protects your code and contributors. |
| 50 | + |
| 51 | +This template provides an [Apache Licence 2.0](https://www.apache.org/licenses/LICENSE-2.0). |
| 52 | +> If you want another one, check this [guide](https://choosealicense.com). |
| 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). |
| 55 | + |
| 56 | +### About |
| 57 | + |
| 58 | +Update the `About` section by adding a description, a website, and topics. |
| 59 | + |
| 60 | +### Templates |
| 61 | + |
| 62 | +This template provides the must-have templates. |
| 63 | + |
| 64 | +#### Issues |
| 65 | + |
| 66 | +An issue is a tool to track and focus tasks. |
| 67 | + |
| 68 | +This template provides two issues templates : |
| 69 | +- `Bug Report` |
| 70 | +- `Feature Request` |
| 71 | + |
| 72 | +Change the default assignee of the [bug_report](./ISSUE_TEMPLATE/bug_report.yml) template. |
| 73 | + |
| 74 | +Change the default assignee of the [feature_request](./ISSUE_TEMPLATE/feature_request.yml) template. |
| 75 | + |
| 76 | +#### Pull Requests |
| 77 | + |
| 78 | +A pull request is an event where a contributor asks a maintainer to review code. |
| 79 | + |
| 80 | +This template provides a [pull request template](./pull_request_template.md). You don't need to update it. |
| 81 | + |
| 82 | +#### Milestones |
| 83 | + |
| 84 | +A milestone helps to track progress on groups of issues or pull requests. |
| 85 | + |
| 86 | +This template provides a [milestone template](./milestone_template.md). You don't need to update it. |
| 87 | + |
| 88 | +### Labels |
| 89 | + |
| 90 | +A label helps to categorize issues and pull requests. |
| 91 | + |
| 92 | +Make sure to have the following labels : |
| 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 |
| 108 | + |
| 109 | +### GitHub project |
| 110 | + |
| 111 | +Create a GitHub project to manage your milestones, issues and pull requests. |
| 112 | + |
| 113 | +### Actions |
| 114 | + |
| 115 | +This template provides some GitHub actions. |
| 116 | + |
| 117 | +#### Release Drafter |
| 118 | + |
| 119 | +A release is tool with changelogs that present a full history of a project. |
| 120 | + |
| 121 | +This template provides an [action](./workflows/release-drafter.yml) that drafts [next releases notes](./release-drafter.yml) as pull requests are merged into the main branch. You don't need to update it. |
| 122 | +> Check this [action's documentation](https://github.com/release-drafter/release-drafter) to understand how it works |
| 123 | +
|
| 124 | +### Settings |
| 125 | + |
| 126 | +#### Visibility |
| 127 | + |
| 128 | +Make your repository public. |
| 129 | + |
| 130 | +## Sprints |
| 131 | + |
| 132 | +In this part, you will learn how to manage sprints. |
| 133 | + |
| 134 | +A sprint is associated as a milestone.\ |
| 135 | +A task is associated as an issue. |
| 136 | + |
| 137 | +### Workflow |
| 138 | + |
| 139 | +The workflow to follow is: |
| 140 | + |
| 141 | +1) Create a milestone |
| 142 | +2) Create all the needed issues linked to this milestone |
| 143 | +3) Manage the pull requests linked with these issues using the GitHib project |
| 144 | +4) Resolve these issues |
| 145 | +5) Publish a release |
| 146 | +6) Close the milestone |
| 147 | + |
| 148 | +### Milestones |
| 149 | + |
| 150 | +Each milestones must use the [milestone template](./milestone_template.md). |
| 151 | + |
| 152 | +There are two parts : |
| 153 | +- Overall |
| 154 | + > **⚠️ It's checklist must be completed before starting this sprint ⚠️** |
| 155 | +- Final Report |
| 156 | + > **⚠️ It's checklist must be completed before starting a new sprint ⚠️** |
| 157 | +
|
| 158 | +Additional information is written in the milestones's checklists. Read them carefully! |
| 159 | + |
| 160 | +### Issues |
| 161 | + |
| 162 | +Create all the required issues of a sprint before starting it. Once the sprint started, no issue linked to it should be create. |
| 163 | + |
| 164 | +**Each issue must be linked to a milestone and a GitHub project, have the right labels and be assigned to someone.** |
| 165 | + |
| 166 | +You can discuss in a issue, do it as much as you can! |
| 167 | + |
| 168 | +### Pull Requests |
| 169 | + |
| 170 | +**Each pull request must be linked to an issue and a GitHub project, have the right labels, be assigned to someone and have a reviewer.** |
| 171 | + |
| 172 | +You can discuss in a pull request, do it as much as you can! |
| 173 | + |
| 174 | +### GitHub project |
| 175 | + |
| 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 | + |
| 178 | +It is a powerful tool, use it well! |
| 179 | + |
| 180 | +### Releases |
| 181 | + |
| 182 | +**Each update on the main branch must be linked to a release.** |
| 183 | + |
| 184 | +Tag pull requests with the `patch`, `minor` or `major` labels. |
| 185 | + |
| 186 | +## Notes |
| 187 | + |
| 188 | +### Discord Webhook |
| 189 | + |
| 190 | +We strongly advice you to have a discord channel on which you will receive GitHub updates on your project. |
| 191 | + |
| 192 | +Follow this [tutorial](https://gist.github.com/SGTGunner/50d6a3cc0d489cf779f77695ba3e22ea). |
| 193 | + |
| 194 | +### Security dependabot |
| 195 | + |
| 196 | +We strongly advice you to have a security dependabot to fix vulnerable dependencies. |
| 197 | + |
| 198 | +Follow this [tutorial](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#managing-dependabot-security-updates-for-your-repositories). |
| 199 | + |
| 200 | +### Help |
| 201 | + |
| 202 | +If you have any questions, please contact [Reza Rahemtola](https://github.com/RezaRahemtola). |
| 203 | + |
| 204 | +> Made with ❤️ by PoC |
0 commit comments