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

Build a contribution guide #5

Open
arnab opened this issue Apr 8, 2014 · 1 comment
Open

Build a contribution guide #5

arnab opened this issue Apr 8, 2014 · 1 comment

Comments

@arnab
Copy link

arnab commented Apr 8, 2014

Since we'll need help from other members to prepare pages like the events/gallery etc.

I can think of the following ways folks would like to (or can) contribute:

  • Github PR: contributor needs to be sufficiently savvy with setting up git/GH/Ruby/Jekyll. Markdown is the easy part.
  • Fork and use Github's Markdown editor on github.com: Basically, fork the repo, then use Github.com on the forked personal repo to add (example) or edit (example) pages. Then the contributor can create PRs as the first step to have the changes merged into the main repo. We will need to include more detailed help for this kind of contribution, since the jekyll rake tasks to create pages/posts won't be available - and the user will need to add the YAML front matter manually.

@hrj - thoughts?

@hrj
Copy link
Member

hrj commented Apr 8, 2014

Well, I think most contributors will be contributing only once in a blue moon, and typically they wouldn't be aware of Git, etc. I expect most of them to just email us an article either in plain text or markdown, and we (the admins) can then add it to the website, either as a PR or, for minor edits, by directly pushing the changes.

For those rare and brave contributors that want to edit directly, we should probably go with option 2 (using Github's editor). They need not even create the PR. They can just point us to a URL and we can pull ourselves.

Option 1 is only suitable for those who are already familiar with Git and website development stacks. For these users, we need not write a guide, because they will be able to pick up by themselves.

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

2 participants