Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (51 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 2.24 KB

Contributing Guidelines

Thank you for considering contributing to this project!
We welcome all kinds of contributions — from bug reports and feature requests to code improvements and documentation updates.

🧭 How to Contribute

  1. Fork the repository.
  2. Create a new branch for your changes (for example: feature/your-feature-name).
  3. Make your changes and commit them.
  4. Push the branch to your fork.
  5. Open a Pull Request (PR) from your fork to the main (or dev) branch of this repository.

🧱 Code Style

Please follow these general guidelines:

  • Keep code readable, modular, and consistent.
  • Use meaningful names for variables, functions, and classes.
  • Add comments where logic is complex or non-obvious.
  • Run linters or formatters (if available) before committing.
  • Avoid large PRs — keep them focused and atomic.

🧪 Testing

Before submitting a PR:

  • Ensure all existing tests pass.
  • Add new tests for any new functionality.
  • If testing tools are not yet set up, describe how you verified your changes in the PR description.

📝 Commit Messages

Please write clear and descriptive commit messages following this format:
type(scope): short summary

Examples

  • feat(ui): add new settings menu
  • fix(core): resolve crash when saving files
  • docs: update contributing guidelines

Common Types

  • feat → new feature
  • fix → bug fix
  • docs → documentation
  • refactor → code restructuring
  • style → formatting or naming cleanup
  • test → adding or updating tests

🪣 Issues and Feature Requests

If you find a bug or want to suggest a new feature:

  1. Check existing issues to avoid duplicates.
  2. Use the appropriate issue template, if available.
  3. Be descriptive — include context, steps to reproduce, and screenshots or logs if possible.

💬 Communication

  • Use GitHub Issues or Discussions for questions or suggestions.
  • Be respectful and constructive when engaging with others.
  • All contributors must follow the Code of Conduct (see CODE_OF_CONDUCT.md if present).

Thank you for helping make this project better