Contributing to snakedown
Thanks for wanting to contribute! There are many ways to contribute and we appreciate any level you’re willing to do. This repository is just for snakedown itself if the issue, request or contribution is to do with the theme, please report that in the specific repository.
Feature Requests
Need some new functionality? You can let us know by opening an issue. Please include a good description of what you would like and what you are hoping to accomplish with it. If you have considered alternatives or current work arounds it is often also helpful to describe those.
In general if your feature request is well written and complete it vastly increaces the chances it will be picked up soon. In general we don’t ask for information for no reason, so if you omit things that may slow things down.
Bug Reports
Please let us know about what problems you run into, whether in behavior or ergonomics of API. You can do this by opening an issue.
When you do so please include the version you were using as well good descriptions of what you were doing that may have triggered the error and what you expect to happen instead (unless it is trivial for example when you are reporting a crash)
In general if your bug report is well written and complete it vastly increaces the chances it will be picked up soon. In general we don’t ask for information for no reason, so if you omit things that may slow things down.
Pull Requests
Looking for an idea? Check our issues. If the issue looks open ended, it is probably best to post on the issue how you are thinking of resolving the issue so you can get feedback early in the process. We want you to be successful and it can be discouraging to find out a lot of re-work is needed. We encourage you to reach out and ask questions early in the process if you are uncertain.
Don’t know where to start? Check out the issues labeled good first issue and mentoring available. In general these are beginner friendly with more detailed instructions.
Already have an idea? It might be good to first create an issue to propose it so we can make sure we are aligned and lower the risk of having to re-work some of it and the discouragement that goes along with that.
Also see what is involved in submitting a PR in the guidelines section of this book.