Website/docs/md/tutorials/make-a-pr.md

59 lines
2.0 KiB
Markdown
Raw Normal View History

2023-03-02 21:11:32 -05:00
## Requirements
2023-03-02 21:11:37 -05:00
- An account on https://dev.sp-tarkov.com/
2023-03-02 21:11:32 -05:00
- Motivation to contribute to a repo
## How-to create a pull request
This will learn you how to contribute to SPT-Aki repositories on dev.sp-tarkov.com by using the website.
### Forking a project and editing its files
1. Fork the project you want to contribute to.
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
![](./assets/img/spt-aki/tutorials/pull-requests/img01.png)
2. *(optional)* Change the forked repository name and informations
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
![](./assets/img/spt-aki/tutorials/pull-requests/img02.png)
3. By clicking the "Fork Repository" it should bring you directly to your newly "copied" repository.
You can now directly modify the file from the gitea website file editor.
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
![](./assets/img/spt-aki/tutorials/pull-requests/img03.png)
![](./assets/img/spt-aki/tutorials/pull-requests/img04.png)
4. Add a helpful commit message (at the bottom of the page) and click on the "Commit changes" button.
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
![](./assets/img/spt-aki/tutorials/pull-requests/img05.png)
You should see your changes in the file.
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
![](./assets/img/spt-aki/tutorials/pull-requests/img06.png)
<div class="doc-info">You can now create a pull request on the original repository to submit your changes!</div>
### Creating the actual Pull Request
1. Go onto the original repository page and click the "New Pull Request" button.
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
![](./assets/img/spt-aki/tutorials/pull-requests/img07.png)
2. Select your repository in the right dropdown menu (should update the page and highlight the changes between your fork and the original repository).
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
![](./assets/img/spt-aki/tutorials/pull-requests/img08.png)
3. Click the "New Pull Request" button.
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
![](./assets/img/spt-aki/tutorials/pull-requests/img09.png)
4. Fill the form with informations that would help others better understand your changes and click the "Create Pull Request" button.
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
![](./assets/img/spt-aki/tutorials/pull-requests/img10.png)
<div class="doc-info">You have now created a pull request!</div>
## Official links
**Guilded link**: https://www.guilded.gg/senkospub
2023-03-02 21:11:35 -05:00
2023-03-02 21:11:32 -05:00
**Written by Sgt.Floof**