ghcitui/CONTRIBUTING.md
2023-06-06 22:19:12 -07:00

2.6 KiB
Raw Blame History

Contributing

We're open to contributions! You can help by filing issues and making pull requsets.

Style

This project is auto-formatted currently by Fourmolu, with settings specified in fourmolu.yaml. This is subject to change.

This project roughly tries to follow the Kowainik Style guide. Though there are some notable diverges, some of which are listed below.

Divergences

  • Try to limit lines to 100 characters, but no hard limit.
  • Let the auto-formatter handle spacing/alignment.

Code of Conduct

This is a slightly simplified version of the Contributor Covenant Code of Conduct (see Attribution)

We as contributors promise to make this repository a welcoming and inclusive space for everyone, regardless of age, body, visible or invisible disability, ethnicity, sex or sex characteristics, gender identity, gender expression, level of experience, education, socio-economic status, nationality, race, caste, colour, religion, sexual identity, and sexual orientation.

We as a contributor are expected to:

  • Show empathy and kindness to others
  • Be respectful of differing opinions and experiences,
  • Give and gracefully accep feedback
  • Respect artist wishes at all times (particularly in regards to distribution terms and conditions)
  • Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

  • The use of sexualized language or imagery, and sexual attention or advances of any kind
  • Trolling, insulting or derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others private information, such as a physical address or email address, without their explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Enforcement

If it's determined by the project leaders that a member of the community has violated the above expectations for a contributor, then these leaders may impose an indefinite ban on that member of the community.

Project leaders have the right and responsibility to review, edit, or deny any contributions which violate or are not aligned with this Code of Conduct.

Scope

This code of conduct applies to all contributors and potential contributors to this project, as well as individuals acting as representatives of this project or the community.

Attribution

This code of conduct was partially adapted from the Contributor Covenant version 2.1.