evolix/EvoBSD
21
0
Fork 0
Code Issues 2 Pull requests Releases 3 Wiki Activity

Adds contribution guidelines

Browse source 
To read closely before any contributions.
This commit is contained in:
Patrick Marchand 2019-01-03 12:53:58 -05:00
parent ec4070302d
commit 4cd9136bec
2 changed files with 19 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,18 @@
# Contributing
Contributions are welcome, as long as they respect our current workflow:
1. The master branch is only for releases. Once properly tested,
the dev branch can be merged, the release tagged and a tar archive
created.
2. The dev branch should never be commited to directly, unless
you're updating the CHANGELOG file.
3. Use feature branches for anything else, once they've passed all
CI tests and have been reviewed by other contributors through a
pull request, they may be merged into the dev branch.
Open issues liberally, but please review closed and opened issues
for duplicates before hand.

7
README.md
View file

@ -127,12 +127,7 @@ pass out on em0 inet from tap0:network to any nat-to (em0)
*assuming em0 is your egress interface*
## Contributions
Contributions to this project are most welcome! The best way is to
create a pull request on https://gitea.evolix.org/evolix/EvoBSD so
we can review and merge it.
See the [contribution guidelines](CONTRIBUTING.md)
## License