Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 4.37 KB

CONTRIBUTING.md

File metadata and controls

107 lines (76 loc) · 4.37 KB
Raw

Contributing

Contributions are always welcome and appreciated! Here are some ways you can contribute.

Getting help

In case you have trouble while using this module, you may use the GitHub Discussion.

Issues

You can and should open an issue for any of the following reasons:

  • You found a bug; steps for reproducing, or a pull request with a failing test case will be greatly appreciated.
  • You wanted to do something but did not find a way to do it after reading the documentation.
  • You believe the current way of doing something is more complicated or less elegant than it can be.
  • A related feature that you want is missing from the package.

Please always check for existing issues before opening a new issue.

Pull Requests

You want to contribute some code? Great! Here are a few steps to get you started:

  1. Fork the repository on GitHub.

  2. Clone your fork and create a branch for the code you want to add.

  3. Build templates using build.bat or build.sh.

  4. Install and test templates.

  5. Update README.md if necessary.

  6. Push your branch and submit a pull request to the master branch on GitHub.

    Incomplete/Work In Progress pull requests are encouraged, because they allow you to get feedback and help more easily.

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 team at [INSERT EMAIL ADDRESS]. 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