pulse

1# Contributing to Pulse
2 
3Thank you for your interest in contributing! Pulse is a community-driven project and we welcome all forms of contribution.
4 
5## How to Contribute
6 
7### Reporting Issues
8 
9- Search existing issues before opening a new one.
10- Use the bug report or feature request templates.
11- Include Minecraft version, Fabric Loader version, and a log file if reporting a crash.
12- Attach screenshots or video for visual issues.
13 
14### Submitting Pull Requests
15 
161. Fork the repository.
172. Create a feature branch from `main`.
183. Make your changes following the code style guidelines.
194. Write tests where applicable.
205. Ensure the project builds with `./gradlew build`.
216. Open a pull request against `main` and fill out the PR template.
22 
23## Code Style
24 
25- **Java 25** language features are encouraged (pattern matching, records, sealed classes, etc.).
26- **No comments in code.** Write self-documenting code with clear identifiers. Comments rot; code does not.
27- **JavaDoc is required for all public API** — classes, methods, and fields that form the public contract of a module must have a JavaDoc comment.
28- Follow the existing formatting: 4-space indentation, no tabs, braces on the same line.
29- Keep methods small and focused. A method should do one thing.
30- Use meaningful names. Avoid abbreviations.
31 
32## PR Process
33 
341. A maintainer will review your PR within a few days.
352. Address review feedback or explain why a suggestion is out of scope.
363. Once approved, a maintainer will squash-merge your PR.
374. Your commit will appear on `main` and be included in the next release.
38 
39## Development Setup
40 
41See [DEVELOPMENT.md](DEVELOPMENT.md) for detailed setup instructions, build commands, and profiling guidance.
42