Feature Request
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I have an issue when [...]
So currently the only way to know what style would be preferred for contributions is if you go into the code and look. Without that context, it's much harder for contributors to come in and make meaningful changes without having to throw away a lot of work.
An example of this is this discussion thread: #72 (comment)
Describe the solution you'd like
A clear and concise description of what you want to happen. Add any considered drawbacks.
Add a Style Guide to the project. This will likely need to be added in Contributing.md and possibly the README.
As I've personally never written an official Style Guide, any help would be very much appreciated in doing this. I'll also do some research on other projects to see how they handled this issue.
What I'd need help with is:
- What are the important things to capture
- Where should I mention these things
- What can be automated vs. what will I need to look out for in PRs?
Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
Currently there are no alternatives but I'd like to leave this space for adding them as research is done and advice is potentially given.
Teachability, Documentation, Adoption, Migration Strategy
If you can, explain how users will be able to use this and possibly write out a version in the docs.
Maybe a screenshot or design?
When talking on contributors, try to find the intersection between making the process of making a contribution as painless as possible while also maintaining a project as painless as possible.