diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f95d690..c7f923b 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -59,12 +59,15 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. +reported by contacting the project team at yelamanyelmuratov@gmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. ## Enforcement Guidelines diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..62bd128 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. +4. The style of commits must fit Arlo's Commit Notation. Read more: https://github.com/RefactoringCombos/ArlosCommitNotation/ +5. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + + Summary of the Arlo's Commit Notation: + + CommandLineComparator img \ No newline at end of file diff --git a/TODO.md b/TODO.md index ca3b266..722b6e9 100644 --- a/TODO.md +++ b/TODO.md @@ -9,7 +9,6 @@ Tasks for the project are listed below: * [ ] Markdown snippets * [ ] Startup project * [ ] Add codecov and coverage badge -* [ ] Add contributing guide * [ ] Cover the project completely with tests * [ ] Refactor the code based on ApprovalTests architectural rules * [ ] Add more detailed documentation to the project @@ -23,3 +22,4 @@ Tasks for the project are listed below: * [x] Deploy to pub.dev * [x] Check the causes of incorrect file paths in Windows * [x] Deploy script to automate the deployment process to pub.dev +* [x] Add contributing guide