You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

89 lines
3.9 KiB

1 year ago
  1. # Contributing
  2. When contributing to this repository, please first discuss the change you wish to make via issue,
  3. email, or any other method with the owners of this repository before making a change.
  4. Please note we have a code of conduct, please follow it in all your interactions with the project.
  5. ## Pull Request Process
  6. 1. Ensure any install or build dependencies are removed before the end of the layer when doing a
  7. build.
  8. 2. Update the README.md with details of changes to the interface, this includes new environment
  9. variables, useful file locations and parameters.
  10. 3. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
  11. do not have permission to do that, you may request the second reviewer to merge it for you.
  12. ## Code of Conduct
  13. ### Our Pledge
  14. In the interest of fostering an open and welcoming environment, we as
  15. contributors and maintainers pledge to making participation in our project and
  16. our community a harassment-free experience for everyone, regardless of age, body
  17. size, disability, ethnicity, gender identity and expression, level of experience,
  18. nationality, personal appearance, race, religion, or sexual identity and
  19. orientation.
  20. ### Our Standards
  21. Examples of behavior that contributes to creating a positive environment
  22. include:
  23. * Using welcoming and inclusive language
  24. * Being respectful of differing viewpoints and experiences
  25. * Gracefully accepting constructive criticism
  26. * Focusing on what is best for the community
  27. * Showing empathy towards other community members
  28. Examples of unacceptable behavior by participants include:
  29. * The use of sexualized language or imagery and unwelcome sexual attention or
  30. advances
  31. * Trolling, insulting/derogatory comments, and personal or political attacks
  32. * Public or private harassment
  33. * Publishing others' private information, such as a physical or electronic
  34. address, without explicit permission
  35. * Other conduct which could reasonably be considered inappropriate in a
  36. professional setting
  37. ### Our Responsibilities
  38. Project maintainers are responsible for clarifying the standards of acceptable
  39. behavior and are expected to take appropriate and fair corrective action in
  40. response to any instances of unacceptable behavior.
  41. Project maintainers have the right and responsibility to remove, edit, or
  42. reject comments, commits, code, wiki edits, issues, and other contributions
  43. that are not aligned to this Code of Conduct, or to ban temporarily or
  44. permanently any contributor for other behaviors that they deem inappropriate,
  45. threatening, offensive, or harmful.
  46. ### Scope
  47. This Code of Conduct applies both within project spaces and in public spaces
  48. when an individual is representing the project or its community. Examples of
  49. representing a project or community include using an official project e-mail
  50. address, posting via an official social media account, or acting as an appointed
  51. representative at an online or offline event. Representation of a project may be
  52. further defined and clarified by project maintainers.
  53. ### Enforcement
  54. Instances of abusive, harassing, or otherwise unacceptable behavior may be
  55. reported by contacting the project team.
  56. All complaints will be reviewed and investigated and will result in a response that
  57. is deemed necessary and appropriate to the circumstances. The project team is
  58. obligated to maintain confidentiality with regard to the reporter of an incident.
  59. Further details of specific enforcement policies may be posted separately.
  60. Project maintainers who do not follow or enforce the Code of Conduct in good
  61. faith may face temporary or permanent repercussions as determined by other
  62. members of the project's leadership.
  63. ### Attribution
  64. This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
  65. available at [http://contributor-covenant.org/version/1/4][version]
  66. [homepage]: http://contributor-covenant.org
  67. [version]: http://contributor-covenant.org/version/1/4/