Skip to content

Commit 167d6b1

Browse files
Create CONTRIBUTING.md
1 parent 829e30b commit 167d6b1

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## A special note to contributors
2+
3+
Please follow the below rules while contributing your build script to this repo.
4+
5+
1. Please mention in notes that, whether the script is made for root user or non-root user.
6+
2. Always keep the package version/commitID in variable. Try to take version as parameter otherwise take a default version number you are working on. Below is the example:
7+
``` shell
8+
VERSION=${1:-v5.0.2}
9+
# v5.0.2 is the default version, in case of no parameter passed to the script.
10+
```
11+
3. Always create a directory for each new package/component and place [LICENSE](https://github.com/ppc64le/build-scripts/blob/master/LICENSE) file into it.
12+
4. Package name & Filenames must be in **lowercase**.
13+
5. Get Legal approvals incase of any code change/patch.
14+
6. Build script templates can be found [here](https://github.com/ppc64le/build-scripts/tree/master/templates).
15+
7. Test the build script on clean UBI container before raising PR. Include test logs as part of PR.
16+
8. Try to create a branch on your forked repo for each PR.

0 commit comments

Comments
 (0)