Skip to content
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

Create separate Markdown files for various sections of readme that require more detail #8

Open
claudijd opened this issue Nov 12, 2013 · 0 comments

Comments

@claudijd
Copy link
Collaborator

Since we now have markdown, which supports file linking, we could (if we wanted to) segment more of the complicated section of the REAMME.md into separate files with more detail.

One file I'd suggest in the onset would be a "CONTRIBUTING.md" file. This basically gives people the rules of the road for contributing to the project such as where to send bugs/feature requests, how to submit VID/Backoff fingerprints, etc.

Here's an example of one from another ruby project I have that I build from another smarter person than I about how to setup a solid CONTRIBUTING file.

Check it out, I'd like your feedback before pushing forward on this.

https://github.com/claudijd/c7decrypt/blob/master/CONTRIBUTING.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant