KeyWeeUsr / bibliography.space

A simple website to list books with properties.

bibliography.space

A simple website to list books with properties with even simpler API.

How to contribute

GitHub

1. Open the latest book template_
2. Go to the new book form_ and paste the template as is
3. Edit the template fields according to the legend at the top of the template

4. Pick a new UUID with DuckDuckGo UUID_

   Note

   Repeat for all UUID fields if all of them are new. For example, if you are a new contributor and you are adding a new book with an author who's not listed in the DB, you need an UUID for you, the book item, the book title and the author.

   If you are adding a new book for an existing author, you need to pick the UUID of the author and use it in the template (sample author_).

5. Verify the UUID is okay with /check/<uuid> API_

   Note

   404 for your UUID means it's OK to use

6. Name the file as <author>--<title>.yaml
7. Submit the form as a new pull request
8. Wait for review and merge
9. Enjoy :)

Git (CLI)

1. Create your own fork
2. Clone the fork.
3. Create a new branch (git checkout -b <branch>)
4. Navigate to the repository's books folder
5. Generate a new UUIDs:
   • DuckDuckGo UUID_
   • UUID in Powershell_
   • use uuidgen

6. Verify the UUID is okay with /check/<uuid> API_

   Note

   404 for your UUID means it's OK to use

7. Copy the template to a file named <author>--<title>.yaml
8. Fill the fields (GitHub note for reference)
9. Commit the new file
10. Push the changes to your fork (git push -u origin <branch>)
11. Navigate to this repository
12. Open a pull-request
13. Wait for review and merge
14. Enjoy :)