-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chores, docs: Update actions, readme, contributing, code of conduct (#72
- Loading branch information
Showing
7 changed files
with
141 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 team at mithi.sevilla@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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| Thank you for your interest in contributing to this project! | ||
| All types of contributions are welcome, no matter how big or small. | ||
|
|
||
| ## Useful things: | ||
| - Before contributing, please discuss the change you wish to make in an issue before making this change. | ||
| - I use a automated code formatters ([prettier][prettier_link] for Javascript, [black][black_link] for Python for example) to format my code. | ||
| - I use [code climate][code_climate_link] to check for code smells. | ||
| - Please read [the commit style guide][commit_style_guide_link], the guide which I try to adhere to when wording my commit messages. These are not rules, just a guide. | ||
| - I prefer PRs with fewer commits. Squash the commits and push force if you need to. But of course, it's better if all the changes in one commit are logically connected. Thoughtfully-written explanations and the rationale of the pull request is always appreciated. Here's [a simple git workflow](https://github.com/mithi/hexapod/wiki/Simple-Git-Workflow-guide) I try to stick to. | ||
| - And of course, Don't be mean :) [](https://www.contributor-covenant.org/) | ||
|
|
||
| ## Here's a few examples of ways you can help: | ||
| - Work on an existing issue (feature request, bug, etc) | ||
| - Add new tests and test cases to improve code coverage | ||
| - Work on optimizations, performance, speed, efficiency improvements | ||
| - Report or work on bugs | ||
| - Suggest Idiomatic code and better software practices | ||
| - Suggest ways to improving code quality / readability | ||
| - Improve User Interface / Experience Design | ||
| - Improve documentation | ||
| - More on: [Types of Code Contributions][contribute_link]! | ||
|
|
||
|
|
||
| [contribute_link]: https://github.com/mithi/hexapod/wiki/Types-of-(code)-Contributions | ||
| [commit_style_guide_link]: https://github.com/mithi/hexapod/wiki/Commit-Style-Guide | ||
| [git_workflow_link]: https://github.com/mithi/hexapod/wiki/Simple-Git-Workflow-guide | ||
| [prettier_link]: https://github.com/mithi/hexapod/blob/master/.prettierrc.yaml | ||
| [black_link]: https://github.com/psf/black | ||
| [code_climate_link]: https://github.com/mithi/hexapod/blob/master/.codeclimate.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.