Skip to content

Update 03.1-mechanics.md #25

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

Open
elliec wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update 03.1-mechanics.md #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 14 additions & 14 deletions 03.1-mechanics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# Mechanics of Contributing

## CONTRIBUTING.md
Jumping into a new project can be hard and intimidating. Lower the friction to join in by having contributor guidelines (usually in a CONTRIBUTING.md file, linked from the README). This document will help others understand the way your community works and how you interact with each other.

Good questions to address in contributor guidelines:

* How do I report a bug?
* How do I set up my development environment?
* How do I submit changes to the code base?
* **Where can I ask for help?** - make sure you point users to an IRC channel / forum / email address that will be responsive and welcoming to newcomers.

## Issues
* GitHub repositories come with an issue tracker
* Issues communicate specific needs or questions to contributors
* How to create an issue
* When should you create an issue
GitHub repositories come with an issue tracker. Tease out tasks in your issue tracker to help others understand where they can get involved and what's being worked on. Issues communicate specific needs or questions to contributors. Take time to document tasks, features, bugs, or questions in the issue tracker to let others know how they can help. This is often the main forum for public discussion on a project.

Tease out tasks in your issue tracker to help others understand where they can get involved and what's being worked on. Issues communicate specific needs or questions to contributors. Take time to document tasks, features, bugs, or questions in the issue tracker to let others know how they can help. This is often the main forum for public discussion on a project.
[This guide](https://guides.github.com/features/issues/) explains GitHub issues and the different tools available to help manage and organise them

* When should you create an issue

## Version Control
* commits
Expand All @@ -29,12 +38,3 @@ Tease out tasks in your issue tracker to help others understand where they can g
*


## CONTRIBUTING.md
Jumping into a new project can be hard and intimidating. Lower the friction to join in by having contributor guidelines (usually in a CONTRIBUTING.md file, linked from the README). This document will help others understand the way your community works and how you interact with each other.

Good questions to address in contributor guidelines:

* How do I report a bug?
* How do I set up my development environment?
* How do I submit changes to the code base?
* **Where can I ask for help?** - make sure you point users to an IRC channel / forum / email address that will be responsive and welcoming to newcomers.