utilities/kmon
utilities/kmon
1
0
Fork 0
mirror of https://github.com/orhun/kmon synced 2024-06-29 06:24:54 +00:00
Code Issues Projects Releases Wiki Activity

chore: Move code of conduct and contributing guidelines to the root folder

Browse Source
This commit is contained in:
orhun 2020-02-10 11:09:41 +03:00
parent fc2c3ee3b8
commit 1def1c995f
No known key found for this signature in database
GPG Key ID: B928720AEC532117
2 changed files with 122 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project owner at orhunparmaksiz@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.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

46
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,46 @@
# Contributing
Thank you for considering to contribute to [kmon](https://github.com/orhun/kmon/)!
When contributing, please first discuss the change you wish to make via [issue](https://github.com/orhun/kmon/issues),
[email](mailto:orhunparmaksiz@gmail.com), or any other method with the owners of this repository before making a change.
Please note we have a [code of conduct](https://github.com/orhun/kmon/blob/master/.github/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
## Setup
1. Fork this repository and create your branch from `master`.
```
git clone https://github.com/[username]/kmon && cd kmon
```
2. Build the project for installing the dependencies.
```
cargo build
```
3. Use `cargo run` command for starting the terminal interface while development.
4. Add your tests or update the existing tests according to the changes.
```
cargo test --all
```
5. Make sure [rustfmt](https://github.com/rust-lang/rustfmt) and [clippy](https://github.com/rust-lang/rust-clippy) pass before creating a pull request.
```
cargo fmt --all -- --check
cargo clippy -- -D warnings
```
## Create Pull Request
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the [README.md](https://github.com/orhun/kmon/blob/master/README.md) with details of changes to the terminal user interface including new environment variables, command line arguments and container parameters.
3. Increase the version number in [Cargo.toml](https://github.com/orhun/kmon/blob/master/Cargo.toml) to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of the two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
# License
By contributing, you agree that your contributions will be licensed under [GNU General Public License 3.0](https://github.com/orhun/kmon/blob/master/LICENSE).