Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (26 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 1.43 KB
Raw

Welcome to the "Better Study Workflow" contributing guide

Make Changes

  1. Fork this repository
  2. Create a new branch
  3. Make your changes
  4. Commit your update
  5. Push your changes to your fork
  6. Submit a pull request
  7. Wait for approval
  8. Celebrate! 🎉😎

Commit Style

Use a consistent commit style by following the Conventional Commits specification. If not sure, ask ChatGPT to create a commit message for you.

Commit Name (Subject) Examples

feat(tools): add 'obsidian.md' file

style(readme): add heading to README.md

fix(readme): fix typo in README.md

Commit Description (Body)

The commit description should be used to explain the changes made in the commit if the commit name is not enough.

License

This repository is licensed under the CC0 1.0 Universal, meaning you are free to use it for any purpose, commercial or non-commercial, without any attribution back to me (public domain). By contributing, you agree that your contributions will be under the same license.

Attribution

If you use it for your own project or workflow, I'd love to hear about it! (Find me here: @markelekdotcom But you are in no way required to do so.

Also, if you like this repository, consider giving it a star (at the top of this page).

Do not forget to add yourself to the CREDITS section if you want!