A decentralized music tracking and discovery platform built on AT Protocol 馃幍
rocksky.app
listenbrainz
spotify
atproto
lastfm
musicbrainz
scrobbling
1# Contributing Guidelines
2
3Thank you for your interest in contributing to our project. Whether it's a bug
4report, new feature, correction, or additional documentation, we greatly value
5feedback and contributions from our community.
6
7Please read through this document before submitting any issues or pull requests
8to ensure we have all the necessary information to effectively respond to your
9bug report or contribution.
10
11## Reporting Bugs/Feature Requests
12
13We welcome you to use the GitHub issue tracker to report bugs or suggest
14features.
15
16When filing an issue, please check existing open, or recently closed, issues to
17make sure somebody else hasn't already reported the issue. Please try to include
18as much information as you can. Details like these are incredibly useful:
19
20- A reproducible test case or series of steps
21- The version of our code being used
22- Any modifications you've made relevant to the bug
23- Anything unusual about your environment or deployment
24
25## Contributing via Pull Requests
26
27Contributions via pull requests are much appreciated. Before sending us a pull
28request, please ensure that:
29
301. You are working against the latest source on the _master_ branch.
312. You check existing open, and recently merged, pull requests to make sure
32 someone else hasn't addressed the problem already.
333. You open an issue to discuss any significant work - we would hate for your
34 time to be wasted.
35
36To send us a pull request, please:
37
381. Fork the repository.
392. Modify the source; please focus on the specific change you are contributing.
40 If you also reformat all the code, it will be hard for us to focus on your
41 change.
423. Ensure local tests pass.
434. Commit to your fork using clear commit messages.
445. Send us a pull request, answering any default questions in the pull request
45 interface.
466. Pay attention to any automated CI failures reported in the pull request, and
47 stay involved in the conversation.
48
49GitHub provides additional document on
50[forking a repository](https://help.github.com/articles/fork-a-repo/) and
51[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
52
53## Finding contributions to work on
54
55Looking at the existing issues is a great way to find something to contribute
56on. As our projects, by default, use the default GitHub issue labels
57(enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any
58'help wanted' issues is a great place to start.
59
60## Code of Conduct
61
62This project has adopted the
63[Contributor Covenant](https://www.contributor-covenant.org/), version 2.1,
64available at
65https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
66
67## Licensing
68
69See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to
70confirm the licensing of your contribution.