Skip to content

Commit 1927259

Browse files
devnetkcdevnetkc
authored
📝 Add templates and additional documentation for project (#23)
Add code of conduct contribution guide bug report template enhancement request template
1 parent 7580a15 commit 1927259

File tree

5 files changed

+171
-22
lines changed

5 files changed

+171
-22
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!-- markdownlint-disable -->
2+
---
3+
name: Bug report
4+
about: Create a report to help us improve
5+
title: 'bug: brief description of issue discovered'
6+
labels: bug
7+
assignees: ''
8+
9+
---
10+
11+
**Which Version of WordPress SSH Git CI are you running**
12+
- [e.g. v1.0.1 or PR #]
13+
14+
**Describe the bug**
15+
A clear and concise description of what the bug is.
16+
17+
**To Reproduce**
18+
Steps to reproduce the behavior:
19+
1. Go to '...'
20+
2. Click on '....'
21+
3. Scroll down to '....'
22+
4. See error
23+
24+
**Expected behavior**
25+
A clear and concise description of what you expected to happen.
26+
27+
**Screenshots**
28+
If applicable, add screenshots to help explain your problem.
29+
30+
**Web Server (please complete the following information):**
31+
- Server Host Company [e.g. SiteGround, HostGator]
32+
- OS: [e.g. `uname -r` returns `3.12.18-clouder0`]
33+
- SSH: [e.g `watch ssh` returns `/usr/bin/ssh`]
34+
35+
**Repository Server (please complete the following information):**
36+
- Host Company [e.g. Azure DevOps, BitBucket]
37+
38+
**Additional context**
39+
Add any other context about the problem here.
40+
<!-- markdownlint-restore -->

‎.github/ISSUE_TEMPLATE/enhancement-request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- markdownlint-disable -->
2+
---
3+
name: Enhancement request
4+
about: Suggest an idea for this project
5+
title: 'improvement: Your suggested change here'
6+
labels: enhancement
7+
assignees: ''
8+
9+
---
10+
11+
**Is your feature request related to a problem? Please describe.**
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
**Describe the solution you'd like**
15+
A clear and concise description of what you want to happen.
16+
17+
**Describe alternatives you've considered**
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
**Additional context**
21+
Add any other context or screenshots about the feature request here.
22+
<!-- markdownlint-restore -->

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# 📈 Contributing
2+
3+
Contrabutions are welcome! Learn morn on how to contribute on the [Wiki page](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/Contributing) or here or [CONTRIBUTING.md](https://github.com/devnetkc/wordpress-ssh-git-ci/blob/master/CONTRIBUTING.md).
4+
5+
## 📚 Getting Started
6+
7+
### 📌 [Kanban Roadmap Board](https://github.com/devnetkc/wordpress-ssh-git-ci/projects/1)
8+
9+
This is a simple script project to automate a painful manual process I dealt with every day at the office. This gets a WordPress git repository on a unix server and Azure DevOps to play nice with one another.
10+
11+
If you see some adjustments to make, by all means suggest them. This needs some clean up and refactoring yet.
12+
13+
New issues or requests will be tracked on the [kanban board](https://github.com/devnetkc/wordpress-ssh-git-ci/projects/1) for the project.
14+
15+
### :bowtie: Emoji's in commits
16+
17+
Emoji guide can be found here on the [gimoji project site](https://gitmoji.carloscuesta.me/). Choose an emoji from the list provided above that fitst the fix or change you are submitting
18+
19+
### 🔀 Submitting a pull request
20+
21+
1) Fork the repository [wordpress-ssh-git-ci](https://github.com/devnetkc/wordpress-ssh-git-ci)
22+
2) Create a new branch off of [master](https://github.com/devnetkc/wordpress-ssh-git-ci/tree/master)
23+
3) Make your changes
24+
- Commit messages not as important, but will help you in making your PR
25+
4) Create a [Pull Request](https://github.com/devnetkc/wordpress-ssh-git-ci/pulls) for your change into [master](https://github.com/devnetkc/wordpress-ssh-git-ci/tree/master)
26+
- First line is `:emoji_name: what this pr does` > 100 characters
27+
- In the description include all commit messages as changes -- the squash is coming
28+
29+
It is also recommended to keep your pull request down to one specific issue or feature at a time.

‎README.md‎

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -101,34 +101,14 @@ Essentially, it allows WordPress developers to be more hands off with their shar
101101

102102
## 📈 Contributing
103103

104-
Contrabutions are welcome!
104+
Contrabutions are welcome! Learn morn on how to contribute on the [Wiki page](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/Contributing) or here or [CONTRIBUTING.md](https://github.com/devnetkc/wordpress-ssh-git-ci/blob/master/CONTRIBUTING.md).
105105

106-
### 📚 Getting Started
107-
108-
#### 📌 [Kanban Roadmap Board](https://github.com/devnetkc/wordpress-ssh-git-ci/projects/1)
109-
110-
This is a simple script project to automate a painful manual process I dealt with every day at the office. This gets a WordPress git repository on a unix server and Azure DevOps to play nice with one another.
106+
### 📌 [Kanban Roadmap Board](https://github.com/devnetkc/wordpress-ssh-git-ci/projects/1)
111107

112108
If you see some adjustments to make, by all means suggest them. This needs some clean up and refactoring yet.
113109

114110
New issues or requests will be tracked on the [kanban board](https://github.com/devnetkc/wordpress-ssh-git-ci/projects/1) for the project.
115111

116-
#### :bowtie: Emoji's in commits
117-
118-
Emoji guide can be found here on the [gimoji project site](https://gitmoji.carloscuesta.me/). Choose an emoji from the list provided above that fitst the fix or change you are submitting
119-
120-
#### 🔀 Submitting a pull request
121-
122-
1) Fork the repository [wordpress-ssh-git-ci](https://github.com/devnetkc/wordpress-ssh-git-ci)
123-
2) Create a new branch off of [master](https://github.com/devnetkc/wordpress-ssh-git-ci/tree/master)
124-
3) Make your changes
125-
- Commit messages not as important, but will help you in making your PR
126-
4) Create a [Pull Request](https://github.com/devnetkc/wordpress-ssh-git-ci/pulls) for your change into [master](https://github.com/devnetkc/wordpress-ssh-git-ci/tree/master)
127-
- First line is `:emoji_name: what this pr does` > 100 characters
128-
- In the description include all commit messages as changes -- the squash is coming
129-
130-
It is also recommended to keep your pull request down to one specific issue or feature at a time.
131-
132112
## ❓ Wiki & FAQ
133113

134114
A [Wiki](https://github.com/devnetkc/wordpress-ssh-git-ci/wiki/) is available for the project and is moderatly managed.

0 commit comments

Comments
 (0)