❤️ Thank you very much for contributing! ❤️
Given this is a CLI that can be used on many platforms, I'd love to hear what your use case is and how the tool has failed to meet it. This can be unexpected behavior, runtime error, unhandled edge case, unachieved requirements, etc. This is generally what I would refer to as context, and I love me some yummy context when it comes to projects. 😋
bugs, errors, crashes
When opening a fix issue, any sample data or templates that could help reproduce whatever you're running into would be seriously appreciated.
roadmap, novelty, big items
For suggestions on brand new functionality, it'll be be great to know what benefits you expect from that feature. This can be practical, novel, or humorous -- any work! 😄
features, asks, small items
Requests are very similar to suggestions, but focus on small items that aren't broken. Think of these as improvements that can be made to the system. Requests should explain expected functionality thoroughly and potentially offer solutions and alternatives if possible.
Normally, I'd include code and style guidelines here, but I'm honestly a scrub at Rust. Instead I present the following requests as my minimum for considering a PR:
- The PR must be opened against the
devbranch of this repo - Context must be provided in the description
- Documentation updates must be added for user-facing changes
- New code must compile through the accompanying pipeline run
- A pug image or emojii should be added at the end of the PR description
- ⛄