docs: add a contributing guide and link it from the README and site
Nothing in the repo said that pull requests go to develop rather than master, or that release-plz reads the commit subject to pick the next version. Both cost a first-time contributor a round trip. CONTRIBUTING.md covers those, the three checks CI runs, and the fact that the e2e suites skip without a soulfind server. The README and the community page link to it, and it joins the footer's Project column.
This commit is contained in:
@@ -647,6 +647,12 @@ soulfind instead of skipping.
|
||||
points `SOULFIND_BIN` at it, and runs both the library and CLI e2e suites
|
||||
with `SOULSEEK_E2E_REQUIRED=1`, so a missing server fails instead of skipping.
|
||||
|
||||
## Contributing
|
||||
|
||||
Issues and pull requests both welcome. Branch off `develop`, keep the change
|
||||
small, and see [CONTRIBUTING.md](./CONTRIBUTING.md) for the commit convention
|
||||
and the checks CI runs.
|
||||
|
||||
## License
|
||||
|
||||
MIT. See [LICENSE](./LICENSE).
|
||||
|
||||
Reference in New Issue
Block a user