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

Adding Contribution Guidelines for this repo #1

Open
vindard opened this issue Jan 29, 2019 · 1 comment
Open

Adding Contribution Guidelines for this repo #1

vindard opened this issue Jan 29, 2019 · 1 comment

Comments

@vindard
Copy link
Member

vindard commented Jan 29, 2019

We are currently missing Contribution guidelines to help guide persons who may want to contribute to this repo.

image


This Issue will serve to update the 'Contributing' section with a set of easy-to-follow guidelines that anyone can use to submit their own edit suggestions. It will also serve as our sample Issue for describing the process of making contribution suggestions. The edits to be made will be hashed out in the comments below and on the corresponding Pull Request that will be created from this.

For each Issue, a contributor on this repo will open a corresponding Pull Request and all the contributors will assist in making the necessary changes on that Pull Request to be merged.

We will also create guidelines for persons comfortable enough with using Github for themselves to fork this repo and create Pull Requests to submit their edits directly.


Expected outcome: an edited 'Contributing' section that properly details the contribution process supported by links to both the sample Issue and sample Pull Request used to make the actual edits.

@vindard
Copy link
Member Author

vindard commented Jan 29, 2019

We can probably include a mini-section with tips on 'Issue' styling & structure, e.g. how I linked to the section I was referencing in the comment by using a combo of a screenshot and an anchor link.

We will also need to include an explanation of Markdown, little tips on using Markdown effectively and links to Markdown cheatsheets and samples, given that all the documents in this repo are written using Markdown.

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

1 participant