vrr/airsonic-pulse
2
0
Fork 0
mirror of https://github.com/Airsonic-Pulse/airsonic-pulse.git synced 2026-07-09 21:18:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: update github documentation

Browse source
This commit is contained in:
litebito 2026-05-14 10:54:09 +02:00
parent 76a1cdf7c5
commit 2bf5fffc46
2 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

5
.github/CONTRIBUTING.md vendored
View file

@ -6,7 +6,7 @@ litebito/airsonic-pulse development is a community project, and contributions ar
1. **License Acceptance** All contributions must be licensed as [GNU GPLv3](https://github.com/litebito/airsonic-pulse/blob/main/LICENSE.txt) to be accepted. Use [`git commit --signoff`](https://jk.gs/git-commit.html) to acknowledge this.
2. **No Breakage** New features or changes to existing ones must not degrade the user experience. This means do not introduce bugs, remove functionality, or make large changes to existing themes/UI without prior discussion in an Issue.
3. **Coding standards** Language best-practices should be followed, comment generously, and avoid "clever" algorithms. Refactoring existing messes is great, but watch out for breakage.
4. **Be bold!** Without contributions, this project will vanish. If you just want to help out, try [submiting a patch](https://github.com/litebito/airsonic-pulse/issues?q=is%3Aissue+is%3Aopen+label%3Apatches-welcome) for an open Issue.
4. **Be bold!** Without contributions, this project will vanish. If you just want to help out, try [submitting a patch](https://github.com/litebito/airsonic-pulse/issues?q=is%3Aissue+is%3Aopen+label%3Apatches-welcome) for an open Issue.
5. **Stay relevant** Issues or commentary that is off-topic or tangential to litebito/airsonic-pulse development is subject to moderation. Questions should be focused on improving documentation to solve a problem. Visit [GitHub Discussions](https://github.com/litebito/airsonic-pulse/discussions)
@ -17,8 +17,7 @@ process. Any version above 3.3+ should do the job.
Recent versions of Mavens block http repos. One dependency we use is on an http repo (clingline). As such we specify our own Maven settings file to allow Maven to fetch artifacts from the http repo.
If you want to run the testsuite and get a `.war` is everything went fine,
you this command:
If you want to run the testsuite and get a .war if everything goes fine, use this command:
```
mvn clean package

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -32,3 +32,5 @@ Closes #
- [ ] Code follows project style guidelines (`mvn checkstyle:check` passes)
- [ ] No hardcoded upstream repository references introduced
- [ ] All commits are signed-off (`git commit --signoff`) — required by GPLv3 acceptance