Skip to content

Commit 9d66413

Browse files
author
Alyss Noland
authored
Merge pull request #191 from bc-AlyssNoland/API-918
API-918: Add contribution guidelines and templates
2 parents 0935f60 + 9b7446a commit 9d66413

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
### Expected behavior
2+
3+
4+
### Actual behavior
5+
6+
7+
### Steps to reproduce behavior
8+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#### What?
2+
3+
A description about what this pull request implements and its purpose. Try to be detailed and describe any technical details to simplify the job of the reviewer and the individual on production support.
4+
5+
#### Tickets / Documentation
6+
7+
Add links to any relevant tickets and documentation.
8+
9+
- [Link 1](http://example.com)
10+
- ...
11+
12+
#### Screenshots (if appropriate)
13+
14+
Attach images or add image links here.
15+
16+
![Example Image](http://placehold.it/300x200)

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to the BigCommerce PHP API Client
2+
3+
Thanks for showing interest in contributing!
4+
5+
The following is a set of guidelines for contributing to the BigCommerce PHP API client. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6+
7+
By contributing to the BigCommerce PHP API client, you agree that your contributions will be licensed under its MIT license.
8+
9+
#### Table of Contents
10+
11+
[API Documentation](https://developer.bigcommerce.com/api)
12+
13+
[How Can I Contribute?](#how-can-i-contribute)
14+
* [Your First Code Contribution](#your-first-code-contribution)
15+
* [Pull Requests](#pull-requests)
16+
17+
[Styleguides](#styleguides)
18+
* [Git Commit Messages](#git-commit-messages)
19+
20+
### Your First Code Contribution
21+
22+
Unsure where to begin contributing to the API client? Check our [forums](https://forum.bigcommerce.com/s/group/0F913000000HLjECAW), our [stackoverflow](https://stackoverflow.com/questions/tagged/bigcommerce) tag, and the reported [issues](https://github.com/bigcommerce/bigcommerce-api-php/issues).
23+
24+
### Pull Requests
25+
26+
* Fill in [the required template](https://github.com/bigcommerce/bigcommerce-api-php/pull/new/master)
27+
* Include screenshots and animated GIFs in your pull request whenever possible.
28+
* End files with a newline.
29+
30+
## Styleguides
31+
32+
### Git Commit Messages
33+
34+
* Use the present tense ("Add feature" not "Added feature")
35+
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
36+
* Limit the first line to 72 characters or less
37+
* Reference pull requests and external links liberally

0 commit comments

Comments
 (0)