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

README lacks content #11

Open
5 tasks
glfmn opened this issue Jul 14, 2017 · 2 comments
Open
5 tasks

README lacks content #11

glfmn opened this issue Jul 14, 2017 · 2 comments

Comments

@glfmn
Copy link
Member

glfmn commented Jul 14, 2017

I wanted to checkout #8 to see the changes but without contribution instructions I'm not sure what to do.

We should put together a better, more complete README for our contributors, it doesn't have to be as crazy as the mother of all readmes, but it would be nice to have more.

We could add some cool things like:

  • HackFSU logo
  • description
  • development instructions (how to build with gulp)
  • commit style guide
  • list of contributors?

Thoughts?

Resources

Contributing File

Demonstration of a contributing file
Another option is to add a contributing file (maybe not for this repository but for others) so people eager to participate can get a leg up.

@glfmn
Copy link
Member Author

glfmn commented Jul 14, 2017

Also, here's a link to the screen recorder I used.

@glfmn
Copy link
Member Author

glfmn commented Jul 17, 2017

We can add a HackFSU shield to all of our projects too!

Made with love

[![Made with love][love badge]][home site]

[love badge]: https://img.shields.io/badge/%20made%20with%20♥-HackFSU-brightgreen.svg
[home site]: https://hackfsu.com

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

No branches or pull requests

2 participants