Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (29 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 1.52 KB

Contributing to CoolerDash

Thank you for your interest in contributing to CoolerDash!
This is a small open-source project, and all kinds of contributions are welcome — whether it's reporting bugs, suggesting features, writing documentation, or improving code.

How to Contribute

1. Reporting Issues

  • Use the GitHub Issues page.
  • Clearly describe the problem or suggestion.
  • If possible, include steps to reproduce the issue or screenshots.

2. Suggesting Features

  • Open an issue with the label enhancement.
  • Explain why the feature would be useful and how you imagine it working.

3. Submitting Changes

  • Fork the repository and create a new branch (git checkout -b my-feature).
  • Make your changes with clear, concise commit messages.
  • Ensure your code is formatted and tested (if applicable).
  • Open a Pull Request (PR) against the main branch.
  • Be ready for feedback and discussion.

4. Code Style

  • Keep the code simple and readable.
  • Use meaningful names for variables and functions.
  • Document your changes where necessary (comments or README updates).

Community Guidelines

Please follow our Code of Conduct.
We value inclusivity, respect, and collaboration in all contributions and discussions.

Questions?

If you are unsure about something, feel free to open an issue and ask.
There are no bad questions — newcomers are very welcome!

✨ Thanks for helping make coolerdash better!