Termux
/
termux-packages
mirror of https://github.com/termux/termux-packages
1
0
Fork 0
Code Issues Releases Wiki Activity

update CONTRIBUTING.md

This commit is contained in:
Leonid Pliushch 2021-12-26 17:57:23 +02:00
parent 516ab61feb
commit e61b1cb30e
No known key found for this signature in database
GPG Key ID: 45F2964132545795
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -157,9 +157,9 @@ be blocked from contributing to [Termux](https://github.com/termux) project.
### Submitting new packages: checklist
Besides [packaging policy](#packaging-policy), there is a number of typical
mistakes that could be made when submittung a pull request with new package.
Pay attention to things listed below.
Besides violation of [packaging policy](#packaging-policy), there is a
number of typical mistakes that could be made when submittung a pull
request with new package. Pay attention to things listed below.
1. **Versioning: format**
@ -169,6 +169,8 @@ Pay attention to things listed below.
Examples of valid version specification: `1.0`, `20201001`, `10a`.
Example of version with epoch: `1:2.6.0`
2. **Versioning: if using specific Git commit**
`TERMUX_PKG_VERSION` must contain a commit date in case if you are using
@ -188,6 +190,17 @@ Pay attention to things listed below.
`${TERMUX_PKG_VERSION}` and remember that Bash supports slicing and
other ways to manipulate content referenced through variables.
Examples:
```
TERMUX_PKG_VERSION=1.0
TERMUX_PKG_SRCURL=https://example.com/archive/package-${TERMUX_PKG_VERSION}.tar.gz
```
```
TERMUX_PKG_VERSION=5:4.11.3
TERMUX_PKG_SRCURL=https://example.com/archive/package-${TERMUX_PKG_VERSION:2}.tar.gz
```
4. **Dependencies: build tools**
Don't specify common build tools in package dependencies. This includes
@ -208,7 +221,7 @@ Pay attention to things listed below.
avoid editing patches by hand, especially if you don't understand
format internals.
Patch is typically created by
Patch is usually created by
```
diff -uNr sourcedir sourcedir.mod > filename.patch
```