-
-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New github templates and .editorconfig file.
- Loading branch information
1 parent
dabbd2b
commit 9ad7936
Showing
10 changed files
with
442 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,21 @@ | ||
# top-most EditorConfig file | ||
root = true | ||
|
||
# Default root settings. | ||
[*] | ||
charset = utf-8 | ||
end_of_line = lf | ||
indent_style = space | ||
indent_size = 4 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
# Specific changes for JavaScript, YAML and JSON files. | ||
[*.{yaml,json,js}] | ||
indent_size = 2 | ||
|
||
# Markdown specific rules. | ||
[*.md] | ||
indent_size = 2 | ||
trim_trailing_whitespace = false | ||
max_line_length = 80 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us fix a bug you have found. | ||
--- | ||
|
||
### Describe the Bug | ||
|
||
_A clear and concise description of what the bug is._ | ||
|
||
### To Reproduce | ||
|
||
_Steps to reproduce the behaviour:_ | ||
|
||
1. Go to '...' | ||
1. Click on '...' | ||
1. Scroll down to '...' | ||
1. See error | ||
|
||
### Expected behaviour | ||
|
||
_A clear and concise description of what you expected to happen._ | ||
|
||
### Screenshots | ||
|
||
_If applicable, add screenshots to help explain your problem._ | ||
|
||
![Example Screenshot][screenshot-1] | ||
|
||
### Specifications | ||
|
||
**Desktop (please complete the following information):** | ||
|
||
- Hardware: [e.g. MacBook Pro (13-inch, Mid 2012)] | ||
- OS: [e.g. macOS 10.13.4] | ||
- Browser: [e.g. Chrome, Safari, IE] | ||
- Version: [e.g. 61, 11.1, 9] | ||
|
||
**Smartphone (please complete the following information):** | ||
|
||
- Device: [e.g. iPhoneX] | ||
- OS: [e.g. iOS11.1] | ||
- Browser: [e.g. stock browser, safari] | ||
- Version: [e.g. 22] | ||
|
||
### Additional Context | ||
|
||
_Add any other context about the problem here._ | ||
|
||
[//]: # (Add links to any screenshots or other relevant information below) | ||
|
||
[screenshot-1]: https://ws3.sinaimg.cn/large/006tKfTcly1fr6kihddwhj30b008j74g.jpg |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: General Report | ||
about: A general issue report to help improve our project. | ||
--- | ||
|
||
### Expected Behaviour | ||
|
||
_What did you expect to happen when you encountered this issue?_ | ||
|
||
### Actual Behaviour | ||
|
||
_What actually happened instead?_ | ||
|
||
### Steps to Reproduce the Problem | ||
|
||
_Detail the steps below to help us reproduce the problem you encountered._ | ||
|
||
1. Go to '...' | ||
1. Click on '...' | ||
1. Scroll down to '...' | ||
1. See error | ||
|
||
### Specifications | ||
|
||
_The version of the project you are using, operating system, hardware and anything else that you think may be relevant to reporting this problem._ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea or feature for this project. | ||
--- | ||
|
||
### Is your feature request related to a problem? Please describe. | ||
|
||
_A clear and concise description of what the problem is. e.g. I'm always frustrated when [...]_ | ||
|
||
### Describe the solution you'd like | ||
|
||
_A clear and concise description of what you want to happen._ | ||
|
||
### Describe alternatives you've considered | ||
|
||
_A clear and concise description of any alternative solutions or features you've considered._ | ||
|
||
### Additional Context | ||
|
||
_Add any other context or screenshots about the feature request here._ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Pull Request Template | ||
|
||
Please try and complete the below as best as possible. Some of the fields may | ||
not be necessary so feel free to add or edit as you see fit. | ||
|
||
## Checklist | ||
|
||
_Confirm you have completed the following actions prior to submitting this PR._ | ||
|
||
- [ ] There is an existing issue report for this PR. | ||
- [ ] I have forked this project. | ||
- [ ] I have created a feature branch. | ||
- [ ] My changes have been committed. | ||
- [ ] I have pushed my changes to the branch. | ||
|
||
## Title | ||
|
||
_Give your PR a short title summarising the patch, bug fix or feature._ | ||
|
||
## Description | ||
|
||
_Ensure the PR description clearly describes the problem and solution and provide as much relevant information as possible._ | ||
|
||
## Issue Resolution | ||
|
||
_Tell us which issue this PR fixes._ | ||
|
||
This Pull Request Fixes # | ||
|
||
## Proposed Changes | ||
|
||
_List your proposed changes below._ | ||
|
||
- This PR fixes a bug relating to... | ||
- Adding a patch that enhances the project. | ||
- Various bug fixes. | ||
|
||
## New or Changed Features | ||
|
||
_Does this PR provide new or changed features or enhancements? If so, what is included in this PR?_ | ||
|
||
- Enhancement to the templates. | ||
- Adds a new feature that does x, y and z. | ||
- Solves a long-standing bug that affects a, b and c. | ||
|
||
@justinhartman |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# Copyright (C) 2018 Justin Hartman (https://justin.hartman.me). | ||
# | ||
# This program is free software: you can redistribute it and/or modify | ||
# it under the terms of the GNU Affero General Public License as | ||
# published by the Free Software Foundation, either version 3 of the | ||
# License, or (at your option) any later version. | ||
# | ||
# This program is distributed in the hope that it will be useful, | ||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
# GNU Affero General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU Affero General Public License | ||
# along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
|
||
######################## | ||
### Custom Additions ### | ||
######################## | ||
|
||
|
||
|
||
###################### | ||
### macOS Specific ### | ||
###################### | ||
*.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
|
||
# Icon must end with two \r | ||
Icon | ||
|
||
|
||
# Thumbnails | ||
._* | ||
|
||
# Files that might appear in the root of a volume | ||
.DocumentRevisions-V100 | ||
.fseventsd | ||
.Spotlight-V100 | ||
.TemporaryItems | ||
.Trashes | ||
.VolumeIcon.icns | ||
.com.apple.timemachine.donotpresent | ||
|
||
# Directories potentially created on remote AFP share | ||
.AppleDB | ||
.AppleDesktop | ||
Network Trash Folder | ||
Temporary Items | ||
.apdisk |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Project Change-Log | ||
|
||
Below is a detailed change-log, along with specific tasks completed, for each | ||
version released to date. | ||
|
||
## Version 0.1.0 (17/10/2018) | ||
|
||
- [#new](#new) | ||
- Initial source code checkin. | ||
- New template files in `/inc`. | ||
- New Admin area files in `/admin`. | ||
- New `/config` file. | ||
- New website template design with `/css/`, `/font-awesome/` and `/js/` | ||
folders. | ||
- [#enhancement](#enhancement) | ||
- Added GitHub template files. | ||
- Updated the `README.md` file with project specific information. | ||
- New `.editorconfig` file. | ||
- [#bugfix](#bugfix) | ||
- Updated GitHub template files with project details. | ||
|
||
## Version 0.0.1 (17/10/2018) | ||
|
||
- [#new](#new) | ||
- Initial commit. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
### Table of Contents | ||
|
||
- [Our Pledge](#our-pledge) | ||
- [Our Standards](#our-standards) | ||
- [Our Responsibilities](#our-responsibilities) | ||
- [Scope](#scope) | ||
- [Enforcement](#enforcement) | ||
- [Attribution](#attribution) | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, | ||
body size, disability, ethnicity, gender identity and expression, level of | ||
experience, nationality, personal appearance, race, religion, or sexual | ||
identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behaviour that contributes to creating a positive environment | ||
include: | ||
|
||
- Using welcoming and inclusive language | ||
- Being respectful of differing viewpoints and experiences | ||
- Gracefully accepting constructive criticism | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
|
||
Examples of unacceptable behaviour by participants include: | ||
|
||
- The use of sexualised language or imagery and unwelcome sexual attention or | ||
advances | ||
- Trolling, insulting/derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behaviour and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behaviour. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviours that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an | ||
appointed representative at an online or offline event. Representation of a | ||
project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behaviour may be | ||
reported by contacting the project team [by clicking here][email]. The project | ||
team will review and investigate all complaints, and will respond in a way | ||
that it deems appropriate to the circumstances. The project team is obligated | ||
to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 1.4, available at | ||
[http://contributor-covenant.org/version/1/4][version]. | ||
|
||
[email]: mailto:[email protected]?subject=Contributor+Covenant+Code+of+Conduct | ||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# How to Contribute to This Project | ||
|
||
## Did You Find a Bug? | ||
|
||
- **Ensure the bug was not already reported** by searching on GitHub | ||
under [Issues][issues]. | ||
- If you're unable to find an open issue addressing the problem, | ||
[open a new one][new-issue]. Be sure to include a **title and clear | ||
description**, as much relevant information as possible, and a **code | ||
sample** or an **executable test case** demonstrating the expected | ||
behaviour that is not occurring. | ||
|
||
## Did You Write a Patch That Fixes a Bug? | ||
|
||
- Open a new GitHub pull request with the patch. | ||
- Fork this project | ||
- Create your feature branch: `git checkout -b my-new-feature` | ||
- Commit your changes: `git commit -am 'Add some feature'` | ||
- Push to the branch: `git push origin my-new-feature` | ||
- Submit a pull request :tada: | ||
- Ensure the PR description clearly describes the problem and solution. | ||
Include the relevant issue number if applicable. | ||
|
||
## Do You Intend to Add a New Feature or Change an Existing One? | ||
|
||
- Suggest your change as a [new issue][new-issue] using the label | ||
`enhancement`, **BEFORE** you start writing code. | ||
|
||
Thanks for contributing! :heart: | ||
|
||
[issues]: https://github.com/justinhartman/complete-php7-ecom-website/issues | ||
[new-issue]: https://github.com/justinhartman/complete-php7-ecom-website/issues/choose |
Oops, something went wrong.