Skip to content

Commit

Permalink
some fix
Browse files Browse the repository at this point in the history
  • Loading branch information
htrgouvea committed Nov 10, 2023
1 parent bd4ebda commit 2330ba9
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
28 changes: 28 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) (✿ ◕‿◕)
---
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

0 comments on commit 2330ba9

Please sign in to comment.