Skip to content

Commit b5f296a

Browse files
docs: add create a Pr and approval sections
1 parent fa62457 commit b5f296a

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,14 +168,44 @@ Also make sure to check the formatting of your documentation by building the doc
168168

169169
### How to make a pull request
170170

171+
1. To open a pull request on GitHub, navigate to the main page of your forked repository and click on the "Pull requests" tab.
172+
173+
![Pull requests tab in GitHub](images/contributing/pull-requests-tab.png)
174+
175+
2. Click on the "New pull request" button.
176+
177+
![New pull request button in GitHub](images/contributing/new-pull-request.png)
178+
179+
3. Write a clear and concise title and description for your pull request. Make sure to describe the changes you made and why they are necessary.
180+
171181
*__TODO__: This section should describe how to make a pull request in GitHub.*
172182

173183
### What happens when you submit a pull request (CI/CD)
174184

185+
Once you submit a pull request, a series of checks will be run to ensure that your changes do not introduce any bugs or errors. These checks include:
186+
187+
- **Code formatting**: checks that your code is formatted correctly.
188+
- **Code style**: checks that your code follows the style guidelines.
189+
- **Tests**: runs the tests to ensure that your changes do not break any existing functionality.
190+
191+
If any of these checks fail, you will see an error message in your pull request. You need to fix the errors before your changes can be merged.
192+
To get more information about the errors, you can click on the "Details" link next to the failed check.
193+
194+
175195
*__TODO__: This section should describe how to see the results of the CD/CI checks and how to get more information about errors*
176196

177197
### What to expect from the review process
178198

199+
Once you submit a pull request, a maintainer of the repository will review your changes and provide feedback. The review process may involve:
200+
201+
- **Comments**: the reviewer may leave comments on your pull request to ask questions or provide feedback.
202+
- **Suggestions**: the reviewer may suggest changes to your code or documentation.
203+
- **Approvals**: once the reviewer is satisfied with your changes, they will approve the pull request.
204+
205+
You can make changes to your pull request by pushing new commits to the branch. The pull request will be updated automatically with your new changes.
206+
207+
Once your pull request is approved, it will be merged into the main branch and your changes will be included in the guide.
208+
179209
*__TODO__: This section should describe how review happens in GitHub, how see the comments, and how to submit changes (push a new branch)*
180210

181211
## Additional help
5.98 KB
Loading
8.59 KB
Loading

0 commit comments

Comments
 (0)