search

ISUgenomics / bioinformatics-workbook

Bioinformatics Workbook repository
https://bioinformaticsworkbook.org
MIT License
174 stars 89 forks source link

Add contribution guidelines #11

Closed aseetharam closed 6 years ago

aseetharam commented 6 years ago

as suggested by @hsiaoyi0504

hsiaoyi0504 commented 6 years ago

For the installation part related to jekyll, it's Included in #10 and #12.

aseetharam commented 6 years ago

@hsiaoyi0504 feel free to use whatever the methods you want to commit/make changes. We will leave to the developers to select the method that is most suitable for them. Here at GIF, we are comfortable using Atom for writing and we find it very convenient for our purpose. Please continue using jekyll/RubyGems, if it serves you well 👍 , we will, by no means force users to use one method over the other for contribution.

Our initial contribution guidelines is published here and will be updated with more information soon. I'll close this issue for now and work on other pages in order to improve volunteer contribution experience.

Thanks for bringing this to our attention,

The GIF team.

hsiaoyi0504 commented 6 years ago

@aseetharam I know there are many means to develop, but the point here is to provide the possible methods to do that. The usage of Atom you mentioned is cool. However, it's not clear to new developer to start contributing the repo. Another thing is that without mentioning the library used such as jekyll, it's a hinder to start contribute.

The key difference between the Atom and the installation part I mentioned is that Atom is a code editor, but jekyll is the underlying library used for the web page of this repo. It's not the choice of the editor. It's the native way to use jekyll.

hsiaoyi0504 commented 6 years ago

@aseetharam Thus, it seems to me that mentioning jekyll is the fundamental thing used and tell the user that you can run the jekyll locally our use plugins of editors like the one used in Atom (with link) is a good idea. What's your thought on this ?

hsiaoyi0504 commented 6 years ago

For example, mention the list: https://github.com/planetjekyll/awesome-jekyll-editors.

aseetharam commented 6 years ago

Hi @hsiaoyi0504, Thanks for your comments. Like mentioned before, please continue using whatever the methods that you feel convenient and send us the pull request. We will gladly review your changes and accept them, or suggest modifications if needed.

However, to keep the contribution procedure simple for new users, we prefer following guidelines (as highlighted in the contribution page):

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Edit the files or add files using your favorite editor
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull request so that we can review your changes

This method has less overhead on the new users and allows anyone to contribute without installing any programs. It makes the contribution easy and simple!

Again, thanks for bringing this to our attention. We hope that you start contributing to our workbook!

Best,

The GIF team