Add docs on contributing and code of conduct.
This commit is contained in:
parent
d3df810065
commit
5324638573
74
CODE_OF_CONDUCT.md
Normal file
74
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
# 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 maintainer at spulec@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 [http://contributor-covenant.org/version/1/4][version]
|
||||||
|
|
||||||
|
[homepage]: http://contributor-covenant.org
|
||||||
|
[version]: http://contributor-covenant.org/version/1/4/
|
4
CONTRIBUTING.md
Normal file
4
CONTRIBUTING.md
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
### Contributing code
|
||||||
|
|
||||||
|
If you have improvements to Moto, send us your pull requests! For those
|
||||||
|
just getting started, Github has a [howto](https://help.github.com/articles/using-pull-requests/).
|
33
ISSUE_TEMPLATE.md
Normal file
33
ISSUE_TEMPLATE.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
## Reporting Bugs
|
||||||
|
|
||||||
|
Please be aware of the following things when filing bug reports:
|
||||||
|
|
||||||
|
1. Avoid raising duplicate issues. *Please* use the GitHub issue search feature
|
||||||
|
to check whether your bug report or feature request has been mentioned in
|
||||||
|
the past.
|
||||||
|
2. When filing bug reports about exceptions or tracebacks, please include the
|
||||||
|
*complete* traceback. Partial tracebacks, or just the exception text, are
|
||||||
|
not helpful.
|
||||||
|
3. Make sure you provide a suitable amount of information to work with. This
|
||||||
|
means you should provide:
|
||||||
|
|
||||||
|
- Guidance on **how to reproduce the issue**. Ideally, this should be a
|
||||||
|
*small* code sample that can be run immediately by the maintainers.
|
||||||
|
Failing that, let us know what you're doing, how often it happens, what
|
||||||
|
environment you're using, etc. Be thorough: it prevents us needing to ask
|
||||||
|
further questions.
|
||||||
|
- Tell us **what you expected to happen**. When we run your example code,
|
||||||
|
what are we expecting to happen? What does "success" look like for your
|
||||||
|
code?
|
||||||
|
- Tell us **what actually happens**. It's not helpful for you to say "it
|
||||||
|
doesn't work" or "it fails". Tell us *how* it fails: do you get an
|
||||||
|
exception? A hang? How was the actual result different from your expected
|
||||||
|
result?
|
||||||
|
- Tell us **what version of Moto you're using**, and
|
||||||
|
**how you installed it**. Tell us whether you're using standalone server
|
||||||
|
mode or the Python mocks. If you are using the Python mocks, include the
|
||||||
|
version of boto/boto3/botocore.
|
||||||
|
|
||||||
|
|
||||||
|
If you do not provide all of these things, it will take us much longer to
|
||||||
|
fix your problem.
|
Loading…
Reference in New Issue
Block a user