Skip to content

Commit dfa2f0d

Browse files
Updating Docs
1 parent fea627d commit dfa2f0d

File tree

3 files changed

+81
-0
lines changed

3 files changed

+81
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
![Logo](../docs/img/logo.png "Logo")
2+
3+
Thank you for Contributing
4+
===
5+
6+
We want to make it as easy as possible to contribute changes.
7+
8+
Follow the requirements below for __[Creating Issues](https://github.com/redvanworkshop/sfcc-cli/issues/new)__ and __[Pull Requests](https://github.com/redvanworkshop/sfcc-cli/pull/new)__, to keep everything simple for everyone :)
9+
10+
<img src="https://octodex.github.com/images/dinotocat.png" width="400" />
11+
12+
Creating an Issue
13+
---
14+
15+
Use the Prepopulated Template that we provide. Issues reported that do not use the template will be rejected.
16+
17+
18+
Creating a Pull Request
19+
---
20+
21+
Before you can submit a PR, you will need to:
22+
23+
1. Make a New Branch off of `staging` ( ideally you will name your branch for the issue you are fixing, e,g, `issue-3-fixing-logger` )
24+
2. Commit & Push your New Branch, with a comment like `Fixes #3` to auto trigger a status change for that issue
25+
3. Make your Pull Request into the `develop`
26+
4. Set `Reviewers` and `Assignees` to `Peter Schmalfeldt` ( or other project administrator )
27+
5. Choose an appropriate label from the `Labels`
28+
29+
Now you can submit a new PR using the Prepopulated Template that we provide. PR's submitted that do not use the template will be rejected.

.github/ISSUE_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#### Overview:
2+
3+
_( a detailed overview of the problem this ticket will solve and the targeted audience )_
4+
5+
#### Acceptance Criteria:
6+
7+
_( issue will not be considered complete unless this list of criteria is met, e.g. intended usage, expected functionality, specific metrics met, etc. )_
8+
9+
#### Steps to Duplicate _( required for bug reports )_:
10+
11+
_( a step by step guide written for a person who might be looking at this for the first time )_
12+
13+
#### System Info _( required for bug reports )_:
14+
15+
_( e.g. "MacOS 10.14.2 with ZSH terminal" )_
16+
17+
#### Relevant Documentation _( optional )_
18+
19+
_( e.g. Screenshots, Github Issues, etc )_

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#### What's this PR do?
2+
3+
_[write_something]_
4+
5+
#### Where should the reviewer start?
6+
7+
_[write_something]_
8+
9+
#### How should this be manually tested?
10+
11+
_[write_something]_
12+
13+
#### Any background context you want to provide?
14+
15+
_[write_something]_
16+
17+
#### What are the relevant github issue?
18+
19+
_[write_something]_
20+
21+
#### Screenshots (if appropriate)
22+
23+
_[drag_and_drop_here]_
24+
25+
#### What gif best describes this PR or how it makes you feel?
26+
27+
_[drag_and_drop_something_fun_here]_
28+
29+
#### Definition of Done:
30+
31+
- [ ] You have actually run this locally and can verify it works
32+
- [ ] You have verified that `npm test` passes without issue
33+
- [ ] You have updated the README file (if appropriate)

0 commit comments

Comments
 (0)