From 76b4b780084139244c6e99b48e69e3041238db18 Mon Sep 17 00:00:00 2001 From: Jonas Geuens Date: Wed, 19 Oct 2022 11:31:46 -0700 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd658e76..09db534a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,6 +26,16 @@ python. $ py.test atramhasis/tests/test_views.py ``` +We follow gitflow guidelines for branch naming and merging. Please name your +branches according to these guidelines: +``` +bugfix/_description_of_fix +feature/_description_of_feature +```` + +Branches should be branched from develop and merged back into develop once approved +through a pull request. + Every pull request will be run through [Travis-ci]. When providing a pull request, please run the unit tests first and make sure they all pass. Please provide new unit tests to maintain 100% coverage. If you send us a pull request @@ -37,4 +47,4 @@ know why it's not working. [Travis-ci]: https://travis-ci.org/OnroerendErfgoed/atramhasis [Coveralls]: https://coveralls.io/r/OnroerendErfgoed/atramhasis [pytest]: http://pytest.org -[tox]: http://tox.readthedocs.org \ No newline at end of file +[tox]: http://tox.readthedocs.org