Skip to content

Commit be70fae

Browse files
committed
edit: contributing and templates
1 parent 1762ec8 commit be70fae

File tree

3 files changed

+89
-0
lines changed

3 files changed

+89
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# contributing
2+
[toc]
3+
4+
thanks for using AQLqueryBuilder.js. all contributions are welcome. whether or
5+
not you are considering [contributing code](#code-contributions), please file
6+
an issue. templates are not required.
7+
8+
please try to be respectful of other members of the community and yourself.
9+
10+
## Templates
11+
12+
### features
13+
14+
please file a [feature
15+
request](https://github.com/HP4k1h5/AQLqueryBuilder.js/issues/new?assignees=&labels=&template=feature_request.md&title=)
16+
17+
### bugs
18+
19+
im sorry. please file a [bug report](https://github.com/HP4k1h5/AQLqueryBuilder/issues/new?assignees=HP4k1h5&labels=bug&template=bug_report.md&title=basic)
20+
21+
## code contributions
22+
23+
When contributing code, please:
24+
1) file an issue and describe the bugfix or feature
25+
2) fork this repository
26+
3) checkout the latest version branch, which will be in the `v.X.X.X` format,
27+
and should be the only version branch available. Don't hesitate to ask if it
28+
is unclear.
29+
4) make changes
30+
5) add tests; currently using mochai/chai
31+
run tests with e.g. `yarn test tests/glob`
32+
6) add comments to your functions, and if possible, in the
33+
[typedoc](https://github.com/TypeStrong/typedoc) style
34+
7) submit a merge request from your forked branch into the
35+
latest HP4k1h5/ephemeris `v.X.X.X` branch.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: basic
5+
labels: bug
6+
assignees: HP4k1h5
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Screenshots**
20+
If applicable, add screenshots to help explain your problem.
21+
22+
**Desktop (please complete the following information):**
23+
- OS: [e.g. iOS]
24+
- Browser [e.g. chrome, safari]
25+
- Version [e.g. 22]
26+
27+
**Smartphone (please complete the following information):**
28+
- Device: [e.g. iPhone6]
29+
- OS: [e.g. iOS8.1]
30+
- Browser [e.g. stock browser, safari]
31+
- Version [e.g. 22]
32+
33+
**Additional context**
34+
Add any other context about the problem here.
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 for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)