Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (48 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

72 lines (48 loc) · 2.86 KB

Contributing

Discuss the change you wish to make to @set-state by creating an issue.

We have a code of conduct. Contributors must follow the code of conduct while contributing. Maintainers must also follow the code of conduct while representing @set-state.

Pull Request Process

  1. Update the README.md detailing any changes and examples of usage.
  2. Avoid common language issues in documentation by using npm run proofread.
  3. Use conventional commit format for commit messages.
  4. We follow standard-version. Maintainers will complete the release process using npm run release.

Code of Conduct

Our Pledge

We pledge to create an open and welcoming environment. We pledge to make participation in @set-state and community harassment-free. We want everyone to feel welcome regardless of:

  • age
  • body size
  • disability
  • ethnicity
  • gender identity and expression
  • level of experience
  • nationality
  • personal appearance
  • race
  • religion
  • 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
  • Accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • 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 without explicit permission
  • Other conduct which the community considers inappropriate in a professional setting

Our Responsibilities

Maintainers will respond to any unacceptable behavior. Maintainers must remove, edit, or reject any unacceptable contributions. Maintainers may ban any contributor for inappropriate, threatening, offensive, or harmful behaviors.

Scope

This Code of Conduct applies to @set-state spaces. It also applies to public spaces while someone represents @set-state. Examples of representing @set-state include:

  • using an official @set-state email
  • posting via an official social media account
  • acting as an appointed representative at an online or offline event

Representation of @set-state may be further defined and clarified by @set-state's maintainers.

Enforcement

Report unacceptable behavior to the Owner. Maintainers investigate complaints confidentially.

We expect maintainers to follow and enforce the Code of Conduct in good faith.

Attribution

We adapted this Code of Conduct from the Contributor Covenant, version 1.4.