Skip to content

Commit 0ddb413

Browse files
S0AndS0S0AndS0
committed
💫 Adds teplates, moves ReadMe, and updates existing files
1 parent 40f9559 commit 0ddb413

File tree

7 files changed

+625
-624
lines changed

7 files changed

+625
-624
lines changed

‎.github/PULL_REQUEST_TEMPLATE/BUG_FIX.md‎

Lines changed: 0 additions & 44 deletions
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE/bug_fix.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Bug Fix
3+
about: Template for Pull Request that fixes a bug
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
10+
**Tag the bug**
11+
12+
13+
Fixes `javascript-utilities/example#42`
14+
15+
16+
**Additional context**
17+
18+
19+
Add any other context about the problem here.

‎.github/PULL_REQUEST_TEMPLATE/feature_addition.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Feature Addition
3+
about: Template for Pull Request that adds a feature
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
10+
**Does your feature fix related to a problem too? Please tag the issue number.**
11+
12+
13+
Fixes `javascript-utilities/<repo>#<issue-number>`
14+
15+
16+
Mitigates `javascript-utilities/example#42`
17+
18+
19+
**Describe how your feature should be used.**
20+
21+
22+
A clear and concise description of any changes in how to utilize repository.
23+
24+
25+
**Describe alternatives you've considered**
26+
27+
28+
A clear and concise description of any alternative solutions or features you've considered.
29+
30+
31+
**Additional context**
32+
33+
34+
Add any other context or screenshots about the feature here.

‎.github/README.md‎

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
# Javascript Utilities
2+
[heading__top]:
3+
#javascript-utilities
4+
"Dedicated to building JavaScript tools for static web sites, such as those hosted by GitHub Pages."
5+
6+
7+
Dedicated to building JavaScript tools for static web sites, such as those hosted by GitHub Pages.
8+
9+
10+
------
11+
12+
13+
Table of Contents
14+
15+
16+
- [Top of Document][heading__top]
17+
18+
- [Opening Issues][heading__opening_issues]
19+
20+
- [Reporting Bugs][heading__bug_report]
21+
- [Requesting Features][heading__feature_request]
22+
23+
- [Pull Requests][heading__pull_requests]
24+
25+
- [Fixing Bugs][heading__bug_fixes]
26+
- [Adding Features][heading__feature_additions]
27+
28+
- [:customs: Code of Conduct][heading__code_of_conduct]
29+
30+
[:balance_scale: Licensing][heading__license]
31+
32+
33+
------
34+
35+
36+
## Opening Issues
37+
[heading__opening_issues]:
38+
#opening-issues
39+
"Issues are a great way to show that you care about what Javascript Utilities maintains!"
40+
41+
42+
Issues are a great way to show that you care about what Javascript Utilities maintains, please search existing issues prior to opening new issues, and utilize the following templates when applicable.
43+
44+
45+
### Bug Report
46+
[heading__bug_report]:
47+
#bug-report
48+
"Time for some Entomology"
49+
50+
51+
Encourage developers to take time for some Entomology by capturing detailed [Bug Reports][branch__current__template__issues__bug_report]
52+
53+
54+
### Feature Request
55+
[heading__feature_request]:
56+
#feature-request
57+
"What is your use case?"
58+
59+
60+
Detail what your use cases are for [New Features][branch__current__template__issues__feature_request] for developers to consider adding to future commits.
61+
62+
63+
___
64+
65+
66+
## Pull Requests
67+
[heading__pull_requests]:
68+
#pull-requests
69+
"Be a hero to Javascript Utilities with quality Pull Requests"
70+
71+
72+
Be a hero to Javascript Utilities by making quality Pull Requests with the following templates, or utilize the [General Pull Request][branch__current__template__pull_requests__general] template.
73+
74+
75+
### Bug Fixes
76+
[heading__bug_fixes]:
77+
#bug-fixes
78+
"Squish'em good! And tell Javascript Utilities all about it"
79+
80+
81+
Squish'em good! And tell Javascript Utilities all about it though use of the [Bug Fix][branch__current__template__pull_requests__bug_fix] template.
82+
83+
84+
### New Features
85+
[heading__feature_additions]:
86+
#new-features
87+
"Utilize the New Features Template to provide a synopsis of purposed features"
88+
89+
90+
The [New Features][branch__current__template__pull_requests__feature_addition] template should be utilized to provide a synopsis of purposed features.
91+
92+
93+
___
94+
95+
96+
## Code of Conduct
97+
[heading__code_of_conduct]:
98+
#code-of-conduct
99+
"&#x1F6C3; A teaser pulled from contributor-covenant Code of Conduct"
100+
101+
102+
```
103+
## Scope
104+
105+
This Code of Conduct applies both within project spaces and in public spaces
106+
when an individual is representing the project or its community. Examples of
107+
representing a project or community include using an official project e-mail
108+
address, posting via an official social media account, or acting as an appointed
109+
representative at an online or offline event. Representation of a project may be
110+
further defined and clarified by project maintainers.
111+
112+
```
113+
114+
115+
Review the [whole thing][branch__current__code_of_conduct] to see what is expected of those that maintain code with Javascript Utilities
116+
117+
118+
___
119+
120+
121+
## License
122+
[heading__license]:
123+
#license
124+
"&#x2696; Legal side of Open Source"
125+
126+
127+
```
128+
Dedicated to building JavaScript tools for static web sites, such as those hosted by GitHub Pages.
129+
Copyright (C) <year> S0AndS0
130+
131+
This program is free software: you can redistribute it and/or modify
132+
it under the terms of the GNU Affero General Public License as published
133+
by the Free Software Foundation, version 3 of the License.
134+
135+
This program is distributed in the hope that it will be useful,
136+
but WITHOUT ANY WARRANTY; without even the implied warranty of
137+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
138+
GNU Affero General Public License for more details.
139+
140+
You should have received a copy of the GNU Affero General Public License
141+
along with this program. If not, see <https://www.gnu.org/licenses/>.
142+
143+
```
144+
145+
146+
For further details review full length version of [AGPL-3.0][branch__current__license] License.
147+
148+
149+
150+
[branch__current__template__issues__bug_report]:
151+
/.github/ISSUE_TEMPLATE/bug_report.md
152+
"Source template New Issue file for Bug Reports"
153+
154+
155+
[branch__current__template__issues__feature_request]:
156+
/.github/ISSUE_TEMPLATE/feature_request.md
157+
"Source template New Issue file for Feature Requests"
158+
159+
160+
[branch__current__template__pull_requests__general]:
161+
/.github/pull_request_template.md
162+
"Source template file for general Pull Requests"
163+
164+
165+
[branch__current__template__pull_requests__bug_fix]:
166+
/.github/PULL_REQUEST_TEMPLATE/bug_fix.md
167+
"Source template Pull Request file for Bug Fixes"
168+
169+
170+
[branch__current__template__pull_requests__feature_addition]:
171+
/.github/PULL_REQUEST_TEMPLATE/feature_addition.md
172+
"Source template Pull Request file for New Features"
173+
174+
175+
[branch__current__code_of_conduct]:
176+
/CODE_OF_CONDUCT.md
177+
"Contributor Covenant is the code of conduct that maintainers and contributors agree to abide"
178+
179+
180+
[branch__current__contributing]:
181+
/CONTRIBUTING.md
182+
"Guidelines for smooth development of Pull Requests"
183+
184+
185+
[branch__current__security]:
186+
/SECURITY.md
187+
"Best practices for reporting issues of a security related nature"
188+
189+
190+
[branch__current__license]:
191+
/LICENSE
192+
"&#x2696; Full length version of AGPL-3.0 License"
193+

‎.github/pull_request_template.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Pull Request
3-
about: General format of Pull Request commits
3+
about: Template for general Pull Request
44
title: ''
55
labels: ''
66
assignees: ''

0 commit comments

Comments
 (0)