Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BjoernLoetters authored Feb 1, 2025
1 parent 8c4f53f commit 1c8a5a3
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ First of all, thank you for your interest in contributing to **Jar Jar Parse**!

### How to Contribute

##### Reporting Issues
#### Reporting Issues

If you find a bug or have a feature request, please [open an issue](https://github.com/BjoernLoetters/Jar-Jar-Parse/issues) using one of the predefined templates, if applicable.
In any case, when reporting a bug, please attach a clear concise description including:
Expand All @@ -14,7 +14,7 @@ In any case, when reporting a bug, please attach a clear concise description inc
3. Actual behavior
4. Any relevant logs or error messages

##### Submitting Code Contributions
#### Submitting Code Contributions

We welcome pull requests! To contribute code, follow these steps:

Expand All @@ -39,15 +39,15 @@ We welcome pull requests! To contribute code, follow these steps:
```
6. Open a pull request (PR) against the `main` branch and describe your changes

##### Coding Guidelines
#### Coding Guidelines

- Follow the existing code style, even if this is not your preferred style!
- Keep changes focused and minimal.
- Write meaningful commit messages.
- Ensure new code is covered by tests.
- Document code, even if it is internal!

##### Testing
#### Testing

Before submitting a PR, make sure your changes pass all tests. You can run:

Expand All @@ -57,7 +57,7 @@ mvn clean test

If you add a new feature, consider adding unit tests to cover the functionality.

##### Communication
#### Communication

If you have any questions, feel free to open a dicussion or comment on an issue. We appreciate your contributions and look forward to working together!

Expand Down

0 comments on commit 1c8a5a3

Please sign in to comment.