NTBBloodbath/norgolith

[Feature] Improve contribution experience

Closed this issue · 1 comments

This issue proposes implementing several features to improve the overall quality of life for contributors to this repository.

Code of Conduct

The addition of a clearly defined Code of Conduct (CoC) outlines expected behavior within the repository and fosters a welcoming and inclusive environment for all contributors. It helps establish guidelines for respectful communication and collaboration.

Issue templates

Providing pre-defined templates for different issue types can streamline the contribution process and also keep things consistent for everyone.

  • Bug Report ([Bug]): a template prompting for details like:
    • Steps to reproduce the bug.
    • Expected behavior.
    • Actual behavior observed (including screenshots or error messages if applicable!).
  • Feature Request ([Feature]): a template guiding contributors to describe the desired feature, including:
    • A clear explanation of the feature.
    • A description of the proposed feature and its potential benefits for the project.
    • Any relevant use cases.

Progress

  • Code of Conduct
  • Issue templates

Update: also added a CONTRIBUTING.md file.