search

eicug / eicug.github.io

https://eicug.github.io
2 stars 4 forks source link

Improve docs for contributors #14

Open wdconinc opened 2 years ago

wdconinc commented 2 years ago

Include build instructions beyond the one-liner, some info with bundle install, possibly version restrictions. Basis could be https://github.com/HSF/hsf.github.io/blob/master/jekyll-beginners.md, https://github.com/HSF/hsf.github.io/blob/master/github-beginners.md and https://github.com/HSF/hsf.github.io/blob/master/howto-website.md.

Include documentation on making pull requests 'atomic', include a screenshot to show rendering is not affected, etc. Maybe some of this can also be handled as a pull request template.

buddhasystem commented 2 years ago

Also, the bottom of that page : https://eic.github.io/about/howto.html

wdconinc commented 2 years ago

I was wondering if I had overlooked that, but that's the EICUG SWG page :-D