Add extended contributing guidelines and code of conduct

This commit is contained in:
Juan Carlos Mejías Rodríguez 2019-08-16 14:23:24 -04:00
parent cd88b9f99c
commit f2b30892ac
3 changed files with 75 additions and 11 deletions

46
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,46 @@
# 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, gender identity and expression, level of experience, 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 juan [dot] mejias [at] reduc [dot] edu [dot] cu. The project team will review and investigate all complaints, and will respond in a way that it deems 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 [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

28
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,28 @@
# Contributing guidelines
Contributions are always welcome; however, please read this document in its entirety before submitting a pull request or reporting a bug.
## Creating an issue
To report a bug, propose a feature, etc. create an issue in the [issue tracker](https://github.com/greenled/portainer-stack-utils/issues). Your issue must follow these guidelines for it to be considered. Before submitting:
- Check you are on the latest version, the bug may have already been fixed!
- [Search the issue tracker](https://github.com/greenled/portainer-stack-utils/issues) for your problem, someone may have already reported it.
## Opening a pull request
To contribute, [fork](https://help.github.com/articles/fork-a-repo/)
`greenled/portainer-stack-utils`, commit your changes, and [open a pull
request](https://help.github.com/articles/using-pull-requests/).
Your pull request will be reviewed as soon as possible. You may be asked to make changes to your submission during the review process. Test your changes thoroughly before submitting.
If you are submitting a complex feature, bugfix, refactoring, etc. create a small design proposal in the [issue tracker](https://github.com/greenled/portainer-stack-utils/issues) before you start.
## Code of Conduct
All community members are expected to adhere to the project's [code of conduct](CODE_OF_CONDUCT.md).
## License
Source code contributed to this project will be licensed under the [GNU General Public License version 3](https://www.gnu.org/licenses/gpl-3.0.en.html). See [LICENSE](LICENSE) file for reference.

View File

@ -191,17 +191,7 @@ INFO[0000] Stack created endpoint=primary id=89 stack=asd
## Contributing
So, you want to contribute to the project:
- Fork it
- Download your fork to your PC (git clone https://github.com/your_username/portainer-stack-utils && cd portainer-stack-utils)
- Create your feature branch (git checkout -b my-new-feature)
- Make changes and add them (git add .)
- Commit your changes (git commit -m 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new pull request
If you are submitting a complex feature, create a small design proposal on the [issue tracker](https://github.com/greenled/portainer-stack-utils/issues) before you start.
Contributing guidelines can be found in [CONTRIBUTING.md](CONTRIBUTING.md).
## License