Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (46 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

71 lines (46 loc) · 3.06 KB

bevy_wh_elements Community Guidelines

Welcome to the bevy_wh_elements community! We're excited to have you contribute and be a part of our open-source project. To ensure a positive and collaborative experience for everyone, please review and follow these community guidelines.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Community Expectations
  4. Maintainer Responsibilities
  5. Attribution

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to thedudefromci@gmail.com.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with a clear and descriptive title. In the issue, provide details about the bug, including the steps to reproduce it and your environment (e.g., operating system, browser version).

Suggesting Enhancements

If you have ideas for enhancements, open an issue with a clear title and detailed description of the proposed improvement. Discuss it with the community and get feedback before starting to work on it.

Pull Request Process

  1. Fork the repository and create a new branch from master.
  2. Make your changes and ensure the code lints successfully.
  3. Open a pull request, referencing the related issue (if applicable).
  4. Discuss and iterate on the changes with maintainers and the community.
  5. Ensure all tests pass and the code is well-documented.
  6. Once approved, your changes will be merged.

Community Expectations

Be Respectful

Respect others' ideas, contributions, and viewpoints. Everyone comes from different backgrounds and experiences.

Be Inclusive

We welcome contributors of all levels and backgrounds. Be helpful and considerate, and help create an inclusive environment.

Provide Constructive Feedback

If you have feedback, make sure it is constructive and aimed at improving the project. Avoid unproductive criticism.

Stay on Topic

Keep discussions and contributions relevant to the project. Off-topic discussions may be moved to a more appropriate forum.

Maintainer Responsibilities

Maintainers are responsible for:

  • Reviewing and merging pull requests.
  • Enforcing the code of conduct.
  • Helping newcomers and answering questions.
  • Guiding the overall direction of the project.

Attribution

These community guidelines are adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.