Skip to content

Commit bd1c7c9

Browse files
Add CONTRIBUTING.md and CODEOWNERS file
1 parent 7854b4f commit bd1c7c9

File tree

2 files changed

+77
-0
lines changed

2 files changed

+77
-0
lines changed

CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These owners will be the default owners for everything in the repo, unless a later match takes precedence,
2+
# They will be requested for review when someone opens a pull request.
3+
* @IgorTodorovskiIBM @MikeFultonDev

CONTRIBUTING.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributing
2+
3+
## Issues
4+
5+
Log an issue for any question or problem you might have. When in doubt, log an issue, and
6+
any additional policies about what to include will be provided in the responses. The only
7+
exception is security disclosures which should be sent privately.
8+
9+
Committers may direct you to another repository, ask for additional clarifications, and
10+
add appropriate metadata before the issue is addressed.
11+
12+
## Contributions
13+
14+
Any change to resources in this repository must be through pull requests. This applies to all changes
15+
to documentation, code, binary files, etc.
16+
17+
No pull request can be merged without being reviewed and approved.
18+
19+
## Validate your changes
20+
21+
Verify that the project is working by running `zopen build`.
22+
23+
## Coding Guidelines
24+
25+
When contributing your changes, please follow the following coding guidelines:
26+
* patches: patches should adhere to the coding guidelines from the original project repository. Make sure to add the original project's LICENSE file within the patches
27+
directory.
28+
* zopen framework files: (e.g. buildenv) - It is recommended that you follow the [Google Shell Style Guide](https://google.github.io/styleguide/shellguide.html)
29+
30+
If you are generating a new project, we recommend that you use `zopen generate` to create the correct zopen file and directory structure.
31+
32+
### Commit message
33+
34+
A good commit message should describe what changed and why.
35+
36+
It should:
37+
* contain a short description of the change
38+
* be entirely in lowercase with the exception of proper nouns, acronyms, and the words that refer to code, like function/variable names
39+
* be prefixed with one of the following words:
40+
* fix: bug fix
41+
* hotfix: urgent bug fix
42+
* feat: new or updated feature
43+
* docs: documentation updates
44+
* refactor: code refactoring (no functional change)
45+
* perf: performance improvement
46+
* test: tests and CI updates
47+
48+
### Developer's Certificate of Origin 1.1
49+
50+
<pre>
51+
By making a contribution to this project, I certify that:
52+
53+
(a) The contribution was created in whole or in part by me and I
54+
have the right to submit it under the open source license
55+
indicated in the file; or
56+
57+
(b) The contribution is based upon previous work that, to the best
58+
of my knowledge, is covered under an appropriate open source
59+
license and I have the right under that license to submit that
60+
work with modifications, whether created in whole or in part
61+
by me, under the same open source license (unless I am
62+
permitted to submit under a different license), as indicated
63+
in the file; or
64+
65+
(c) The contribution was provided directly to me by some other
66+
person who certified (a), (b) or (c) and I have not modified
67+
it.
68+
69+
(d) I understand and agree that this project and the contribution
70+
are public and that a record of the contribution (including all
71+
personal information I submit with it, including my sign-off) is
72+
maintained indefinitely and may be redistributed consistent with
73+
this project or the open source license(s) involved.
74+
</pre>

0 commit comments

Comments
 (0)