Skip to content
roastbookPublic

About

Organization profile, community guidelines, and branding for Roastbook.

Topics

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributing to Roastbook

Contributions to Roastbook's coffee journal, open coffee data, schemas, and shared tooling are welcome.

Choose the right repository

Open issues and pull requests in the repository affected by your change. Read its README and any local contribution guide first; repository-specific instructions take precedence over this organization-wide guide.

For the coffee journal, start with the development guide. For datasets and schemas, follow the repository's validation and source requirements.

Report a bug or propose a change

Search existing issues before opening a new one. Include the version, steps to reproduce, expected behavior, and actual behavior. Remove personal data, credentials, and private journal content from logs and screenshots.

For a substantial feature or breaking change, open an issue to discuss the approach before implementing it. Report security vulnerabilities privately as explained in SECURITY.md.

Submit a pull request

Keep changes focused and explain the problem, the resulting behavior, and how you verified it. Run the checks documented by the affected repository and update documentation when behavior changes.

Use Conventional Commits, for example fix: correct brew time formatting or docs: clarify dataset validation. Use a lowercase imperative description, no trailing period, and a subject no longer than 72 characters.

About

Organization profile, community guidelines, and branding for Roastbook.

Topics

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors