diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..73cddf8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +Hello, thank you for your interest into contributing to this project. Your help is really appreciated. + +Please note we have a [Code of Conduct], please follow it in all your interactions with the project. + +--- + +## Git Workflow Policy + +1. Direct push to [Master] is not allowed. +2. Pull Requests to [Master] are not allowed. +3. Usually, commits and pull requests should be done on [Dev] branch. If you have any doubt, don't hesitate to ask first. +4. Temporary branches may be existing for specific features, be pretty sure that the branch you are going to commit on is the right one. Ask first if you have any doubt. +5. Any branch will be finally merged to [Dev], there it will be reviewed and tested deeply before being merged to [Master]. +6. All merges from [Dev] to [Master] are a new `evil-winrm` release. This merges to [Master] will be performed and reviewed exclusively by the staff. + +--- + +[Code of Conduct]: CODE_OF_CONDUCT.md +[Master]: https://github.com/Hackplayers/evil-winrm/tree/master +[Dev]: https://github.com/Hackplayers/evil-winrm/tree/dev