mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-09-21 02:33:32 +00:00
courtmanr@gmail.com
26 lines
1.3 KiB
Markdown
26 lines
1.3 KiB
Markdown
# Contributing to Pulse
|
|
|
|
Thank you for your interest in contributing to Pulse! We appreciate your help. Here are some guidelines to follow:
|
|
|
|
## Reporting Bugs
|
|
|
|
- Please ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/rcourtman/Pulse/issues).
|
|
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/rcourtman/Pulse/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample or an executable test case** demonstrating the expected behavior that is not occurring.
|
|
- Use the "Bug Report" issue template if available.
|
|
|
|
## Suggesting Enhancements
|
|
|
|
- Open a new issue using the "Feature Request" template.
|
|
- Clearly describe the enhancement you are proposing and why it would be beneficial.
|
|
- Provide examples or mockups if possible.
|
|
|
|
## Pull Requests
|
|
|
|
- Fork the repository and create your branch from `main`.
|
|
- Ensure your code adheres to the project's existing style.
|
|
- If you've added code that should be tested, add tests.
|
|
- Ensure the test suite passes (if applicable).
|
|
- Make sure your code lints (if linters are set up).
|
|
- Issue that pull request!
|
|
|
|
We will review your pull request and provide feedback. Thank you for your contribution! |