dir2opds/CONTRIBUTING.md

Contributing

1. Sign one of the contributor license agreements below.

2. Install Go.

3. Clone the repo:

   git clone https://github.com/dubyte/dir2opds.git

4. Change into the checked out source:

   cd dir2opds

5. Fork the repo.

6. Set your fork as a remote:

   git remote add fork https://github.com/GITHUB_USERNAME/dir2opds.git

7. Make changes and commit to your fork. Initial commit messages should follow the Conventional Commits style (e.g. feat(functions): add gophers codelab).

8. Send a pull request with your changes.

9. A maintainer will review the pull request and make comments. Prefer adding additional commits over amending and force-pushing since it can be difficult to follow code reviews when the commit history changes.

   Commits will be squashed when they're merged.