Skip to content

Commit

Permalink
. d added contributing.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
yelmuratoff committed May 10, 2024
1 parent 6104937 commit 91f1779
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 7 deletions.
15 changes: 9 additions & 6 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]. 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

Expand Down
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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:

<img src="https://github.com/K1yoshiSho/packages_assets/blob/main/assets/approval_tests/arlo_git_notation.png?raw=true" alt="CommandLineComparator img" title="ApprovalTests" style="max-width: 500px;">
2 changes: 1 addition & 1 deletion TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

0 comments on commit 91f1779

Please sign in to comment.