diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c50afd9 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. \ No newline at end of file diff --git a/README.md b/README.md index de998b0..2d65ac2 100644 --- a/README.md +++ b/README.md @@ -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