Committing initial version of project
This commit is contained in:
17
.github/CONTRIBUTING.md
vendored
Normal file
17
.github/CONTRIBUTING.md
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# Thank you for Contributing !
|
||||
|
||||
We want to keep it as easy as possible to contribute changes. Just follow these requirements for Creating Issues and Pull Requests, and everything will be super simple for everyong :)
|
||||
|
||||
## Creating an Issue:
|
||||
|
||||
Use the Template that we provide. Issues reported that do not use the template will closed.
|
||||
|
||||
## Creating a Pull Request:
|
||||
|
||||
Before you can submit a PR, you will need to:
|
||||
|
||||
1. Clone this repo
|
||||
2. Make a New Branch ( ideally you will name your branch for the issue you are fixing, e,g, `issue-3-updating-docs` )
|
||||
3. Commit & Push the New Branch
|
||||
|
||||
Now you can submit a new PR using the Template that we provide. PR's submitted that do not use the template will closed.
|
||||
19
.github/ISSUE_TEMPLATE.md
vendored
Normal file
19
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
#### Overview:
|
||||
|
||||
_( a detailed overview of the problem this ticket will solve and the targeted audience )_
|
||||
|
||||
#### Acceptance Criteria:
|
||||
|
||||
_( issue will not be considered complete unless this list of criteria is met, e.g. intended usage, expected functionality, specific metrics met, etc. )_
|
||||
|
||||
#### Steps to Duplicate _( required for bug reports )_:
|
||||
|
||||
_( a step by step guide written for a person who might be looking at this for the first time )_
|
||||
|
||||
#### System Info _( required for bug reports )_:
|
||||
|
||||
_( e.g. "iPhone 6 iOS 8.3" or "OSX 10.10 and Google Chrome Version 44.0.2403.89 (64-bit)" )_
|
||||
|
||||
#### Relevant Documentation _( optional )_
|
||||
|
||||
_( e.g. Screenshots, Github Issues, etc )_
|
||||
33
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
33
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
#### What's this PR do?
|
||||
|
||||
_[write_something]_
|
||||
|
||||
#### Where should the reviewer start?
|
||||
|
||||
_[write_something]_
|
||||
|
||||
#### How should this be manually tested?
|
||||
|
||||
_[write_something]_
|
||||
|
||||
#### Any background context you want to provide?
|
||||
|
||||
_[write_something]_
|
||||
|
||||
#### What are the relevant github issue?
|
||||
|
||||
_[write_something]_
|
||||
|
||||
#### Screenshots (if appropriate)
|
||||
|
||||
_[drag_and_drop_here]_
|
||||
|
||||
#### What gif best describes this PR or how it makes you feel?
|
||||
|
||||
_[drag_and_drop_something_fun_here]_
|
||||
|
||||
#### Definition of Done:
|
||||
|
||||
- [ ] You have actually run this locally and can verify it works
|
||||
- [ ] You have added code comments to all code being submitted
|
||||
- [ ] You have updated the README file (if appropriate)
|
||||
Reference in New Issue
Block a user