Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 3.42 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via an issue, or with the maintainer on the Obsidian Forum before making a change.

I have included a code of conduct, please follow it in all your interactions with the development of this plugin.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Where appropriate, update the README.md with details of changes to the plugin, this includes additions and changes to configuration
    settings, plugin commands, useful file locations and additional installation instructions.
  3. If you can, please include tests in your Pull Request, particularly if you are making significant changes or additions to the behaviour of the plugin.
  4. A CI Test Github Action workflow will run when a new Pull Request is made. The Pull Request cannot be completed until that workflow is passing with the plugin successfully building and all tests passing.
  5. The repository maintainer will be responsible for increasing the version numbers in files and the README.md to the new version that this Pull Request would represent once it has been completed and merged. The versioning scheme used is SemVer.

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.

Attribution

This Code of Conduct is based on and adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4