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
add a contributing file #658
Conversation
Hey, good idea. We actually already have a contributor guide, that just needs to be deployed to the manual: https://github.com/UnionOfRAD/manual/blob/master/en/appendices/contributing.wiki Maybe our |
Sounds also like a good plan. Why is it not deployed over there, yet? Also, Do you use .wiki as extension for a reason? If you would rather use .md instead, it would be more easy to use on github and one could even link to the repository. I wondered about that some months/years ago, already. |
Oh, and as an addition, i would prefer having at least the main-points in the contributing file itself, rather than just a link to a different place. Of course, it would make sense to have these documentation linked for freshness. Nonetheless, having at least some information on display when clicking the "how to contribute" link by github is more friendly. |
@mehlah thanks for the info. Will read that up. :) |
The new manual with the contributor guide has been deployed: http://lithify.me/docs/manual/appendices/contributing.wiki Maybe the 4 main points can just be copied here, and you can provide a link back. |
sounds like a plan - i will take care of that. |
Ok, i am done with it. Here is, how it looks like: Contributing guidelinesThank you for your interest in contributing to Lithium! This project is built by a thriving community of developers who value cutting-edge technology and concise, maintainable code. If you've found a bug, or have an idea for a feature, we encourage your participation in making Lithium better. Here's what you need to stick to in order to have the best chance of getting your code pushed to the core:
Please see the full documentation over at the contribution guidelines at lithify.me |
Please take this as a starting point for contributions docs, according to https://github.com/blog/1184-contributing-guidelines