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

Add CONTRIBUTING file #19

Closed
john-light opened this issue Jun 12, 2018 · 5 comments
Closed

Add CONTRIBUTING file #19

john-light opened this issue Jun 12, 2018 · 5 comments
Labels
enhancement New feature or request

Comments

@john-light
Copy link
Contributor

Create a CONTRIBUTING.md file and contributor guidelines for this repo.

@john-light john-light added the enhancement New feature or request label Jun 12, 2018
@cjyabraham
Copy link
Contributor

To confirm, you're talking about guidelines for contributing to the hack.aragon docs right? I have started a list at the bottom of my doc here. Could you give me an example of a CONTRIBUTING.md file, what it should look like and where it might live?

@john-light
Copy link
Contributor Author

@cjyabraham great question thanks. Yes exactly. You'll notice an issue like this on most repos in this org that do not yet have these guidelines. See examples of contributing guidelines here:

https://blog.github.com/2012-09-17-contributing-guidelines/

@cjyabraham
Copy link
Contributor

Here's a first draft.

@john-light
Copy link
Contributor Author

@cjyabraham thanks! I suggest adding at least one other reviewer who contributes to / uses the docs to take a look. with that I'll get out of your way here :)

luisivan pushed a commit that referenced this issue Oct 25, 2018
…adme.md. (#50)

* updated readme with instructions on setting up a local instance and linking to the contributing file

* first draft of the CONTRIBUTING.md file

* minor edits

* minor edits

* added an additional guideline
@cjyabraham
Copy link
Contributor

This has been merged so I will close this issue. Here's the file.

unixpi added a commit to unixpi/hack that referenced this issue May 19, 2019
0xGabi pushed a commit that referenced this issue May 22, 2019
* Update github-guide.md

Minor edits (tone + grammar)

* Add a couple of HQ images for testing

* Replace first three images

* Add a couple more hq images

* Replace remaining images in 'Editing a document on GitHub' subsection

* Add replacement images for 'Your first edit' subsection

* Delete gh-5-hq.png

Wrong folder

* Delete gh-6-hq.png

Wrong folder

* Add replacement images for 'Your first edit' subsection (correct folder)

* Edit 'Your first edit subsection' and link to replacement images

* Add replacement images for 'Proposing the file change' and 'Comparing changes' subsections

* Link to replacement images in 'Proposing the file change' and 'Comparing changes' subsections + minor edit

* Add replacement images for 'Your first pull request' subsection

* Add links to replacement images in 'Your first pull request' subsection + minor edits

* Add replacement images for 'Adjusting your pull request' subsection

* Add final links to replacement images + minor edits

* Halve width of zoomed in images

* Delete gh-0.png

* Delete gh-1.png

* Delete gh-10.png

* Delete gh-11.png

* Delete gh-12.png

* Delete gh-13.png

* Delete gh-14.png

* Delete gh-15.png

* Delete gh-16.png

* Delete gh-17.png

* Delete gh-18.png

* Delete gh-19.png

* Delete gh-2.png

* Delete gh-20.png

* Delete gh-3.png

* Delete gh-4.png

* Delete gh-5.png

* Delete gh-6.png

* Delete gh-7.png

* Delete gh-8.png

* Delete gh-9.png

* Center img
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants