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.

Sign up for GitHub

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

Issue 388 contributing md file #400

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Issue 388 contributing md file #400

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d5431e
added contributing.md file
buck3000 Oct 1, 2015
edbb740
put some markdown in to see how this file works with github
buck3000 Oct 1, 2015
f393b43
created initial CONTRIBUTING.md file with quicklink
buck3000 Oct 1, 2015
8fb9461
added space after octothorpe (my bad)
buck3000 Oct 19, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Contribution Guidelines

Have you found a bug? Do you have a new idea for a feature? Want to submit an issue to help us improve the site? Thanks so much! Please use the below format to pass on all the details and increase the chance your issue will be picked up.

### Quicklink: [Submit An Issue](https://github.com/CodeMontageHQ/codemontage/issues/new?body=Description%0A-------%0A%20%0A%0AAsk%0A--------%0A%0ASteps%0A--------%0A%0ATo%20Do%20(Optional)%0A--------%0A%0AAdditional%20Info%20(Optional)%0A--------%0A)

### Description
Include a high level description of the feature or error here including steps of how to recreate if applicable. Include any benefits, challenges or considerations. Can be short and sweet. Use GitHub-flavored markdown to link any related issues.

### Ask
Describe the desired behavior and what would deem this issue/bug/feature complete. If there are several options, list them or create separate issues for them.

### To Do (optional)

Steps
To
Complete
Fix
Go in a task list

### Additional Info (optional)
Include any images, steps to recreate, notes, emojis, or whatever. This may helpfully include code snippets, screenshots, and/or videos of a bug in its natural habitat.

#[Create Issue!](https://github.com/CodeMontageHQ/codemontage/issues/new?body=Description%0A-------%0A%20%0A%0AAsk%0A--------%0A%0ASteps%0A--------%0A%0ATo%20Do%20(Optional)%0A--------%0A%0AAdditional%20Info%20(Optional)%0A--------%0A)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is meant to be a header? If so, it needs a space between the octothorpe and the link's opening bracket.


This format is heavily borrowed from [Girl Develop It](https://github.com/girldevelopit/gdi-new-site). Thanks GDI Team!