Closed duckinator closed 1 month ago
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!
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. 😂 )
These are the non-breaking changes, which do not require a major version bump. They can be included in any release.
These changes may require a version bump depending on how they're implemented.
These are the breaking changes, which require a major version bump.
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.
309
310
228
280
275
Potentially-breaking changes
These changes may require a version bump depending on how they're implemented.
242
Breaking changes
These are the breaking changes, which require a major version bump.
205