Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 5.01 KB

CONTRIBUTING.md

File metadata and controls

101 lines (68 loc) · 5.01 KB

Contributing

When contributing to this repository, please first create a new branch for yours changes.

We would love (but you are not obligated) if you discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

A Few Things to Know Before Contributing

  • This project uses Prettier with only one setting changed: printWidth: 100 (You don't have to worry about eslint-prettier warns, because the code is formatted automatically before any commit) PS: If you think that eslint-prettier is annoying, you can "eslint.run": "onSave" on your editor.

  • We use Gitmoji 🤡 to make better commit messages. (Just get the gitmoji code here and past on the commit message).

  • The folder structure is based on the needs of the project, if you want to change it, please open an issue.

  • The CSS styles are all in modules, if you want something in the global scope please use the src/index.css.

  • The project doesn't follow a visual design language (like Material Design), but please try to no lose the visual identity.

First Things First

  • Create a branch for your edits.

  • When Pulling Request, reference any relevant issues or supporting documentation (for example, "Closes #37.")

  • When updating the UI and style files. Please include screenshots of the before and after of your changes. Insert the images into the body of your pull request.

  • If you want to make a substantial contribution, open an issue to ask before working on it.

Pull Request Process

  1. Increase the version numbers to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  2. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make 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 [email protected]. 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, version 1.4, available at http://contributor-covenant.org/version/1/4