jachym/dwl-patches
1
0
Fork 0
mirror of https://codeberg.org/dwl/dwl-patches.git synced 2026-02-04 18:23:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update instructions

Leonardo Hernández Hernández 2024-01-06 20:15:05 -06:00
parent 6986b8466f
commit 47e4f60d3c
No known key found for this signature in database
GPG Key ID: E538897EE11B9624
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
instructions.md

@ -1,21 +1,23 @@
# Instructions for work on dwl patches
## Creating Patches
1. Create a [Codeberg] account and fork the [dwl] repository.
2. Create a branch in your repository for the patch you are generating and maintaining.
1. Create a [Codeberg] account and clone the [dwl] repository.
2. Create a branch in your repository for the patch you are generating and maintaining.
3. Make and test the modifications for your patch.
## Contributing Patches to this Wiki
1. If work has been done to the main branch at [dwl] since you started work on your patch, REBASE YOUR PATCH!
2. In your local clone of your Codeberg dwl fork, add a remote for the main dwl repository:
2. If you do not have it already, add the remote for the main dwl repository in your local copy:
`git remote add upstream https://codeberg.org/dwl/dwl`
3. In your local clone of your Codeberg dwl fork, create a .patch file
3. In your local repository of dwl, create a .patch file
`git format-patch upstream/main...<branch-name> --stdout > PATCHNAME.patch`
4. Fork [https://codeberg.org/dwl/dwl-patches][dwl-patches]
5. In your local copy, add a directory called `PATCHNAME` and place the `PATCHNAME.patch` you created in step three into the `PATCHNAME` directory. You may also place screenshots in the `PATCHNAME` directory that you can later reference in your [dwl-patches wiki][wiki] entry.
6. Use the Codeberg web interface to send a pull request to [dwl-patches] (NOT to [dwl])
7. WHEN YOUR PULL REQUEST IS APPROVED, your Codeberg account will also be granted commit access to [dwl-patches]. When you make updates, replace your `PATCHNAME.patch` file directly. You no longer need to make pull requests. At this point, you will also have access to commit to [dwl-patches] and its [wiki].
8. Add a wiki page using this template (add/remove sections as you like):
5. Configure your repository
`git config --local pull.rebase true`
6. In your local copy, add a directory called `PATCHNAME` and place the `PATCHNAME.patch` you created in step three into the `PATCHNAME` directory. You may also place screenshots in the `PATCHNAME` directory that you can later reference in your [dwl-patches wiki][wiki] entry.
7. Use the Codeberg web interface to send a pull request to [dwl-patches] (NOT to [dwl]) (Codeberg nicely will generate a URL for you)
8. WHEN YOUR PULL REQUEST IS APPROVED, your Codeberg account will also be granted commit access to [dwl-patches]. When you make updates, replace your `PATCHNAME.patch` file directly. You no longer need to make pull requests. At this point, you will also have access to commit to [dwl-patches] and its [wiki].
9. Add a wiki page using this template (add/remove sections as you like):
```markdown
### Description
Insert a short summary of changes that your patch implements.
@ -23,7 +25,7 @@
### Download
- [git branch](https://codeberg.org/USERNAME/dwl/src/branch/PATCHNAME)
- [yyyy-mm-dd](https://codeberg.org/dwl/dwl-patches/raw/branch/main/PATCHNAME/PATCHNAME.patch)
USE THE ^raw^ PATCH LINK HERE
<!--- USE THE ^raw^ PATCH LINK HERE --->
### Authors
- [YOUR_NICK](https://codeberg.org/USERNAME)
```
@ -34,12 +36,12 @@
10. Keep your `PATCHNAME.patch` file AND the associated wiki page updated appropriately.
## Reporting Issues
- Issues with existing patches can be generated here in the dwl-patches [issues](https://codeberg.org/dwl/dwl-patches/issues). Please be sure to "@" reference the patch author in your issue.
- Issues with existing patches can be generated here in the dwl-patches [issues]. Please be sure to "@" reference the patch author in your issue.
- You may choose to submit a pull request to the "git branch" listed for a patch.
- AUTHORS: When you commit an update to a patch to address an issue raised by another user, please add a "closes" tag referencing the appropriate issue number.
## Updating/Modifying Existing Patches
- If the existing patch is being maintained by another author, do not make modifications to it without permission.
- If the existing patch is already being maintained by another author, do not make modifications to it without permission.
- If you have submitted a pull request to the previous author's repository and received no reply after seven days, please feel free to edit the wiki page for the patch with your updated link. Do leave any previous author's nicks/links intact under the "Authors" heading.
@ -47,5 +49,6 @@
[dwl-patches]: https://codeberg.org/dwl/dwl-patches
[Codeberg]: https://codeberg.org
[dwl]: https://codeberg.org/dwl/dwl
[dwl-patches]:https://codeberg.org/dwl/dwl-patches
[wiki]:https://codeberg.org/dwl/dwl-patches/wiki
[dwl-patches]: https://codeberg.org/dwl/dwl-patches
[wiki]: https://codeberg.org/dwl/dwl-patches/wiki
[issues]: https://codeberg.org/dwl/dwl-patches/issues