Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Want to help? Check here first. (Also, thanks!) #284

Open
duckinator opened this issue Mar 29, 2022 · 0 comments
Open

Want to help? Check here first. (Also, thanks!) #284

duckinator opened this issue Mar 29, 2022 · 0 comments

Comments

@duckinator
Copy link
Owner

duckinator commented Mar 29, 2022

It's very hard for me to work consistently on open-source stuff recently.

But Bork is an important project. This issue is my attempt to document the highest-priority work for anyone who wishes to contribute.

I can't promise I'll get to any PRs super quickly, but I'll do my best!

Documentation

The documentation can use a lot of love. I did a bad job of documenting this project, unfortunately.

See https://emanate-docs.netlify.app/ (especially https://emanate-docs.netlify.app/cli.html) for what is (imo) a good example of documentation for another project that is both a command-line tool and a library.

(EDIT: I improved the documentation and now it's better than Emanate's. 😂 )

Non-breaking changes

These are the non-breaking changes, which do not require a major version bump. They can be included in any release.

Potentially-breaking changes

These changes may require a version bump depending on how they're implemented.

Breaking changes

These are the breaking changes, which require a major version bump.

@duckinator duckinator pinned this issue Mar 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant