From 2330ba9b8f023e8155ad1a3a1dd3422e70108ed1 Mon Sep 17 00:00:00 2001 From: htrgouvea Date: Thu, 9 Nov 2023 21:41:59 -0300 Subject: [PATCH] some fix --- .github/CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ README.md | 2 +- SECURITY.md | 2 +- 3 files changed, 30 insertions(+), 2 deletions(-) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..d671bba --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing to the ZARN! + +## Branches + +The `main` branch is used only for holding released code of the project. Any +new feature or bugfix **must** be opened against `develop` branch, where some +additional testing is performed before the code lands `main`. + +## Testing + +For every new feature, please, submit in the same PR a testing code (under +`t/` folder) to cover that completely. Make sure to expand and cover the +added/replaced code as much as possible. + +In case it's a functional bugfix (not a typo, commentary, whitespace, ... +issue), make sure to check why the test code didn't trigger the bug before +and, if possible, update the test. + +## Great Re-Writings + +Open a discussion issue before you begin. So we can listen to what you have to +say, and we can provide a referral if it will be worth changing big parts of +the project. + +## License + +By opening a pull request in this repository, you agree to provide your work +under the [project license](../LICENSE.md). \ No newline at end of file diff --git a/README.md b/README.md index 070ae27..2cccabe 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ rules: ### Contribution -Your contributions and suggestions are heartily ♥ welcome. [See here the contribution guidelines.](/.github/CONTRIBUTING.md) Please, report bugs via [issues page](https://github.com/htrgouvea/nipe/issues) and for security issues, see here the [security policy.](/SECURITY.md) (✿ ◕‿◕) +Your contributions and suggestions are heartily ♥ welcome. [See here the contribution guidelines.](/.github/CONTRIBUTING.md) Please, report bugs via [issues page](https://github.com/htrgouvea/zarn/issues) and for security issues, see here the [security policy.](/SECURITY.md) (✿ ◕‿◕) --- diff --git a/SECURITY.md b/SECURITY.md index 74e181b..33340dd 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,4 +4,4 @@ If you find a security issue, please DO NOT submit it via the issue tracker! Ins Even in cases where you have limited or incomplete information, or you're not sure whether or not a problem constitutes a security issue, please make contact as soon as possible. We can work together to investigate, debug, and assess. -Your help is greatly appreciated in keeping this project secure! +Your help is greatly appreciated in keeping this project secure! \ No newline at end of file