Skip to content

Commit 9ad7936

Browse files
committed
New github templates and .editorconfig file.
1 parent dabbd2b commit 9ad7936

File tree

10 files changed

+442
-4
lines changed

10 files changed

+442
-4
lines changed

.editorconfig

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
1+
# top-most EditorConfig file
12
root = true
23

4+
# Default root settings.
35
[*]
6+
charset = utf-8
7+
end_of_line = lf
48
indent_style = space
59
indent_size = 4
6-
end_of_line = lf
7-
charset = utf-8
8-
trim_trailing_whitespace = true
910
insert_final_newline = true
11+
trim_trailing_whitespace = true
12+
13+
# Specific changes for JavaScript, YAML and JSON files.
14+
[*.{yaml,json,js}]
15+
indent_size = 2
1016

17+
# Markdown specific rules.
1118
[*.md]
19+
indent_size = 2
1220
trim_trailing_whitespace = false
21+
max_line_length = 80
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us fix a bug you have found.
4+
---
5+
6+
### Describe the Bug
7+
8+
_A clear and concise description of what the bug is._
9+
10+
### To Reproduce
11+
12+
_Steps to reproduce the behaviour:_
13+
14+
1. Go to '...'
15+
1. Click on '...'
16+
1. Scroll down to '...'
17+
1. See error
18+
19+
### Expected behaviour
20+
21+
_A clear and concise description of what you expected to happen._
22+
23+
### Screenshots
24+
25+
_If applicable, add screenshots to help explain your problem._
26+
27+
![Example Screenshot][screenshot-1]
28+
29+
### Specifications
30+
31+
**Desktop (please complete the following information):**
32+
33+
- Hardware: [e.g. MacBook Pro (13-inch, Mid 2012)]
34+
- OS: [e.g. macOS 10.13.4]
35+
- Browser: [e.g. Chrome, Safari, IE]
36+
- Version: [e.g. 61, 11.1, 9]
37+
38+
**Smartphone (please complete the following information):**
39+
40+
- Device: [e.g. iPhoneX]
41+
- OS: [e.g. iOS11.1]
42+
- Browser: [e.g. stock browser, safari]
43+
- Version: [e.g. 22]
44+
45+
### Additional Context
46+
47+
_Add any other context about the problem here._
48+
49+
[//]: # (Add links to any screenshots or other relevant information below)
50+
51+
[screenshot-1]: https://ws3.sinaimg.cn/large/006tKfTcly1fr6kihddwhj30b008j74g.jpg

.github/ISSUE_TEMPLATE/CUSTOM.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: General Report
3+
about: A general issue report to help improve our project.
4+
---
5+
6+
### Expected Behaviour
7+
8+
_What did you expect to happen when you encountered this issue?_
9+
10+
### Actual Behaviour
11+
12+
_What actually happened instead?_
13+
14+
### Steps to Reproduce the Problem
15+
16+
_Detail the steps below to help us reproduce the problem you encountered._
17+
18+
1. Go to '...'
19+
1. Click on '...'
20+
1. Scroll down to '...'
21+
1. See error
22+
23+
### Specifications
24+
25+
_The version of the project you are using, operating system, hardware and anything else that you think may be relevant to reporting this problem._
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea or feature for this project.
4+
---
5+
6+
### Is your feature request related to a problem? Please describe.
7+
8+
_A clear and concise description of what the problem is. e.g. I'm always frustrated when [...]_
9+
10+
### Describe the solution you'd like
11+
12+
_A clear and concise description of what you want to happen._
13+
14+
### Describe alternatives you've considered
15+
16+
_A clear and concise description of any alternative solutions or features you've considered._
17+
18+
### Additional Context
19+
20+
_Add any other context or screenshots about the feature request here._

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Pull Request Template
2+
3+
Please try and complete the below as best as possible. Some of the fields may
4+
not be necessary so feel free to add or edit as you see fit.
5+
6+
## Checklist
7+
8+
_Confirm you have completed the following actions prior to submitting this PR._
9+
10+
- [ ] There is an existing issue report for this PR.
11+
- [ ] I have forked this project.
12+
- [ ] I have created a feature branch.
13+
- [ ] My changes have been committed.
14+
- [ ] I have pushed my changes to the branch.
15+
16+
## Title
17+
18+
_Give your PR a short title summarising the patch, bug fix or feature._
19+
20+
## Description
21+
22+
_Ensure the PR description clearly describes the problem and solution and provide as much relevant information as possible._
23+
24+
## Issue Resolution
25+
26+
_Tell us which issue this PR fixes._
27+
28+
This Pull Request Fixes #
29+
30+
## Proposed Changes
31+
32+
_List your proposed changes below._
33+
34+
- This PR fixes a bug relating to...
35+
- Adding a patch that enhances the project.
36+
- Various bug fixes.
37+
38+
## New or Changed Features
39+
40+
_Does this PR provide new or changed features or enhancements? If so, what is included in this PR?_
41+
42+
- Enhancement to the templates.
43+
- Adds a new feature that does x, y and z.
44+
- Solves a long-standing bug that affects a, b and c.
45+
46+
@justinhartman

.gitignore

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Copyright (C) 2018 Justin Hartman (https://justin.hartman.me).
2+
#
3+
# This program is free software: you can redistribute it and/or modify
4+
# it under the terms of the GNU Affero General Public License as
5+
# published by the Free Software Foundation, either version 3 of the
6+
# License, or (at your option) any later version.
7+
#
8+
# This program is distributed in the hope that it will be useful,
9+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
# GNU Affero General Public License for more details.
12+
#
13+
# You should have received a copy of the GNU Affero General Public License
14+
# along with this program. If not, see <https://www.gnu.org/licenses/>.
15+
16+
########################
17+
### Custom Additions ###
18+
########################
19+
20+
21+
22+
######################
23+
### macOS Specific ###
24+
######################
25+
*.DS_Store
26+
.AppleDouble
27+
.LSOverride
28+
29+
# Icon must end with two \r
30+
Icon
31+
32+
33+
# Thumbnails
34+
._*
35+
36+
# Files that might appear in the root of a volume
37+
.DocumentRevisions-V100
38+
.fseventsd
39+
.Spotlight-V100
40+
.TemporaryItems
41+
.Trashes
42+
.VolumeIcon.icns
43+
.com.apple.timemachine.donotpresent
44+
45+
# Directories potentially created on remote AFP share
46+
.AppleDB
47+
.AppleDesktop
48+
Network Trash Folder
49+
Temporary Items
50+
.apdisk

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Project Change-Log
2+
3+
Below is a detailed change-log, along with specific tasks completed, for each
4+
version released to date.
5+
6+
## Version 0.1.0 (17/10/2018)
7+
8+
- [#new](#new)
9+
- Initial source code checkin.
10+
- New template files in `/inc`.
11+
- New Admin area files in `/admin`.
12+
- New `/config` file.
13+
- New website template design with `/css/`, `/font-awesome/` and `/js/`
14+
folders.
15+
- [#enhancement](#enhancement)
16+
- Added GitHub template files.
17+
- Updated the `README.md` file with project specific information.
18+
- New `.editorconfig` file.
19+
- [#bugfix](#bugfix)
20+
- Updated GitHub template files with project details.
21+
22+
## Version 0.0.1 (17/10/2018)
23+
24+
- [#new](#new)
25+
- Initial commit.

CODE_OF_CONDUCT.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
### Table of Contents
4+
5+
- [Our Pledge](#our-pledge)
6+
- [Our Standards](#our-standards)
7+
- [Our Responsibilities](#our-responsibilities)
8+
- [Scope](#scope)
9+
- [Enforcement](#enforcement)
10+
- [Attribution](#attribution)
11+
12+
## Our Pledge
13+
14+
In the interest of fostering an open and welcoming environment, we as
15+
contributors and maintainers pledge to making participation in our project and
16+
our community a harassment-free experience for everyone, regardless of age,
17+
body size, disability, ethnicity, gender identity and expression, level of
18+
experience, nationality, personal appearance, race, religion, or sexual
19+
identity and orientation.
20+
21+
## Our Standards
22+
23+
Examples of behaviour that contributes to creating a positive environment
24+
include:
25+
26+
- Using welcoming and inclusive language
27+
- Being respectful of differing viewpoints and experiences
28+
- Gracefully accepting constructive criticism
29+
- Focusing on what is best for the community
30+
- Showing empathy towards other community members
31+
32+
Examples of unacceptable behaviour by participants include:
33+
34+
- The use of sexualised language or imagery and unwelcome sexual attention or
35+
advances
36+
- Trolling, insulting/derogatory comments, and personal or political attacks
37+
- Public or private harassment
38+
- Publishing others' private information, such as a physical or electronic
39+
address, without explicit permission
40+
- Other conduct which could reasonably be considered inappropriate in a
41+
professional setting
42+
43+
## Our Responsibilities
44+
45+
Project maintainers are responsible for clarifying the standards of acceptable
46+
behaviour and are expected to take appropriate and fair corrective action in
47+
response to any instances of unacceptable behaviour.
48+
49+
Project maintainers have the right and responsibility to remove, edit, or
50+
reject comments, commits, code, wiki edits, issues, and other contributions
51+
that are not aligned to this Code of Conduct, or to ban temporarily or
52+
permanently any contributor for other behaviours that they deem inappropriate,
53+
threatening, offensive, or harmful.
54+
55+
## Scope
56+
57+
This Code of Conduct applies both within project spaces and in public spaces
58+
when an individual is representing the project or its community. Examples of
59+
representing a project or community include using an official project e-mail
60+
address, posting via an official social media account, or acting as an
61+
appointed representative at an online or offline event. Representation of a
62+
project may be further defined and clarified by project maintainers.
63+
64+
## Enforcement
65+
66+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
67+
reported by contacting the project team [by clicking here][email]. The project
68+
team will review and investigate all complaints, and will respond in a way
69+
that it deems appropriate to the circumstances. The project team is obligated
70+
to maintain confidentiality with regard to the reporter of an incident.
71+
Further details of specific enforcement policies may be posted separately.
72+
73+
Project maintainers who do not follow or enforce the Code of Conduct in good
74+
faith may face temporary or permanent repercussions as determined by other
75+
members of the project's leadership.
76+
77+
## Attribution
78+
79+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
80+
version 1.4, available at
81+
[http://contributor-covenant.org/version/1/4][version].
82+
83+
[email]: mailto:hello@22digital.agency?subject=Contributor+Covenant+Code+of+Conduct
84+
[homepage]: http://contributor-covenant.org
85+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# How to Contribute to This Project
2+
3+
## Did You Find a Bug?
4+
5+
- **Ensure the bug was not already reported** by searching on GitHub
6+
under [Issues][issues].
7+
- If you're unable to find an open issue addressing the problem,
8+
[open a new one][new-issue]. Be sure to include a **title and clear
9+
description**, as much relevant information as possible, and a **code
10+
sample** or an **executable test case** demonstrating the expected
11+
behaviour that is not occurring.
12+
13+
## Did You Write a Patch That Fixes a Bug?
14+
15+
- Open a new GitHub pull request with the patch.
16+
- Fork this project
17+
- Create your feature branch: `git checkout -b my-new-feature`
18+
- Commit your changes: `git commit -am 'Add some feature'`
19+
- Push to the branch: `git push origin my-new-feature`
20+
- Submit a pull request :tada:
21+
- Ensure the PR description clearly describes the problem and solution.
22+
Include the relevant issue number if applicable.
23+
24+
## Do You Intend to Add a New Feature or Change an Existing One?
25+
26+
- Suggest your change as a [new issue][new-issue] using the label
27+
`enhancement`, **BEFORE** you start writing code.
28+
29+
Thanks for contributing! :heart:
30+
31+
[issues]: https://github.com/justinhartman/complete-php7-ecom-website/issues
32+
[new-issue]: https://github.com/justinhartman/complete-php7-ecom-website/issues/choose

0 commit comments

Comments
 (0)