Skip to content

Commit 454252d

Browse files
jlenon7jlenon7
authored
Initial commit
0 parents  commit 454252d

27 files changed

+11924
-0
lines changed

‎.editorconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_size = 2
6+
indent_style = space
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.github/COMMIT_CONVENTION.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
## Git Commit Message Convention
2+
3+
Using conventional commit messages, we can automate the process of generating the CHANGELOG file. All commits messages will automatically be validated against the following regex.
4+
5+
``` js
6+
/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|ci|chore|types|build|improvement)((.+))?: .{1,50}/
7+
```
8+
9+
## Commit Message Format
10+
A commit message consists of a **header**, **body** and **footer**. The header has a **type**, **scope** and **subject**:
11+
12+
> The **scope** is optional
13+
14+
```
15+
feat(router): add support for prefix
16+
17+
Prefix makes it easier to append a path to a group of routes
18+
```
19+
20+
1. `feat` is type.
21+
2. `router` is scope and is optional
22+
3. `add support for prefix` is the subject
23+
4. The **body** is followed by a blank line.
24+
5. The optional **footer** can be added after the body, followed by a blank line.
25+
26+
## Types
27+
Only one type can be used at a time and only following types are allowed.
28+
29+
- feat
30+
- fix
31+
- docs
32+
- style
33+
- refactor
34+
- perf
35+
- test
36+
- workflow
37+
- ci
38+
- chore
39+
- types
40+
- build
41+
42+
If a type is `feat` or `fix`, then the commit will appear in the CHANGELOG.md file. However if there is any BREAKING CHANGE, the commit will always appear in the changelog.
43+
44+
### Revert
45+
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>`., where the hash is the SHA of the commit being reverted.
46+
47+
## Scope
48+
The scope could be anything specifying place of the commit change. For example: `router`, `view`, `querybuilder`, `database`, `model` and so on.
49+
50+
## Subject
51+
The subject contains succinct description of the change:
52+
53+
- use the imperative, present tense: "change" not "changed" nor "changes".
54+
- don't capitalize first letter
55+
- no dot (.) at the end
56+
57+
## Body
58+
59+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
60+
The body should include the motivation for the change and contrast this with previous behavior.
61+
62+
## Footer
63+
64+
The footer should contain any information about **Breaking Changes** and is also the place to
65+
reference GitHub issues that this commit **Closes**.
66+
67+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: [jlenon7, txsoura]
2+
open_collective: athennaio

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## 👉 [Please follow one of these issue templates](https://github.com/AthennaIO/Template/issues/new/choose) 👈
2+
3+
<!-- Love Athenna? Please consider supporting our collective: 👉 https://opencollective.com/athenna/donate -->
4+
5+
Note: to keep the backlog clean and actionable, issues may be immediately closed if they do not follow one of the above issue templates.

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Bug Report 🪲
2+
description: Create a bug report to help us improve.
3+
title: '[Bug]: '
4+
labels: ['bug']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
# Please follow these steps first:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
## Troubleshoot
14+
If Athenna is not behaving the way you expect, we'd ask you to look at the [documentation](https://athenna.io/docs/getting-started) and search the issue tracker for evidence supporting your expectation. Please make reasonable efforts to troubleshoot and rule out issues with your code, the configuration, or any 3rd party libraries you might be using.
15+
- type: markdown
16+
attributes:
17+
value: |
18+
## Ask for help through appropriate channels
19+
If you feel unsure about the cause of the problem, consider asking for help on for example [StackOverflow](https://stackoverflow.com/questions/ask) or our [Discord](https://discord.gg/JdEbBAKw6X) before posting a bug report. The issue tracker is not a help forum.
20+
- type: markdown
21+
attributes:
22+
value: |
23+
## Make a minimal reproduction
24+
To file the report, you will need a GitHub repository with a minimal (but complete) example and simple/clear steps on how to reproduce the bug.
25+
26+
The simpler you can make it, the more likely we are to successfully verify and fix the bug.
27+
- type: markdown
28+
attributes:
29+
value: |
30+
:bangbang: &nbsp; Bug reports without a minimal reproduction will be rejected. :bangbang:
31+
32+
---
33+
- type: input
34+
id: version
35+
attributes:
36+
label: Version
37+
description: |
38+
The version you are using.
39+
Is it the [latest](https://github.com/AthennaIO/Template/releases)? Test and see if the bug has already been fixed.
40+
placeholder: ex. 1.0.0
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: reproduction
45+
attributes:
46+
label: Steps to reproduce
47+
description: Please link to a repository with a minimal reproduction and describe accurately how we can reproduce/verify the bug.
48+
placeholder: |
49+
Example steps (replace with your own):
50+
1. Clone my repository at: https://github.com/<myuser>/example
51+
2. npm run install
52+
3. npm run start (You should see the error come up)
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: expected
57+
attributes:
58+
label: Expected behavior
59+
description: A description of what you expect to happen.
60+
placeholder: I expect to see X or Y
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: what-happened
65+
attributes:
66+
label: Actual behavior
67+
description: A clear and concise description of the unexpected behavior.
68+
placeholder: A bug happened!
69+
validations:
70+
required: true
71+
- type: textarea
72+
id: context
73+
attributes:
74+
label: Additional context
75+
description: Anything else that might be relevant
76+
validations:
77+
required: false
78+
- type: textarea
79+
id: envinfo
80+
attributes:
81+
label: Environment
82+
description: |
83+
Please paste the output of running `npx envinfo --system --binaries`.
84+
This will be automatically formatted as a code block, so no need for backticks.
85+
placeholder: |
86+
System:
87+
OS: macOS 12.3.1
88+
CPU: (8) arm64 Apple M1 Pro
89+
Memory: 130.23 MB / 16.00 GB
90+
Shell: 5.8 - /opt/homebrew/bin/zsh
91+
Binaries:
92+
Node: 16.13.1 - ~/.nvm/versions/node/v16.13.1/bin/node
93+
npm: 8.1.2 - ~/.nvm/versions/node/v16.13.1/bin/npm
94+
render: Shell
95+
validations:
96+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Feature Proposal 🚀
2+
description: Submit a proposal for a new feature.
3+
title: '[Feature]: '
4+
labels: ['feature']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
### Thank you for taking the time to suggest a new feature!
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: '🚀 Feature Proposal'
14+
description: A clear and concise description of what the feature is.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Motivation
21+
description: Outline your motivation for the proposal. How will it make @athenna/template better?
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: Example
28+
description: Describe how this feature would be used.
29+
validations:
30+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: 'Questions / Help 💬'
2+
description: If you have questions, please check Discord or StackOverflow.
3+
title: '[Please read the message below]'
4+
labels: ['question']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Questions and Help 💬
10+
11+
This issue tracker is reserved for bug reports and feature proposals.
12+
13+
For anything else, such as questions or getting help, please see:
14+
15+
- [The Athenna help page](https://athenna.io/help)
16+
- [Our `#help` channel in Discord](https://discord.gg/JdEbBAKw6X)
17+
- The [AthennaIO](https://stackoverflow.com/questions/tagged/AthennaIO) tag on [StackOverflow](https://stackoverflow.com/questions/ask)
18+
- type: checkboxes
19+
id: no-post
20+
attributes:
21+
label: |
22+
Please do not submit this issue.
23+
description: |
24+
:bangbang: &nbsp; This issue will be closed. :bangbang:
25+
options:
26+
- label: I understand
27+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!-- CLICK "Preview" FOR INSTRUCTIONS IN A MORE READABLE FORMAT -->
2+
3+
## Proposed changes
4+
5+
Describe the big picture of your changes here to communicate to the
6+
maintainers why we should accept this pull request. If it fixes a bug
7+
or resolves a feature request, be sure to link to that issue.
8+
9+
## Types of changes
10+
11+
What types of changes does your code introduce?
12+
13+
_Put an `x` in the boxes that apply_
14+
15+
- [ ] Bugfix (non-breaking change which fixes an issue)
16+
- [ ] New feature (non-breaking change which adds functionality)
17+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
18+
19+
## Checklist
20+
21+
_Put an `x` in the boxes that apply. You can also fill these out after
22+
creating the PR. If you're unsure about any of them, don't hesitate to ask.
23+
We're here to help! This is simply a reminder of what we are going to look
24+
for before merging your code._
25+
26+
- [ ] I have read the [CONTRIBUTING](https://github.com/AthennaIO/Template/blob/master/CONTRIBUTING.md) documentation
27+
- [ ] Lint and unit tests pass locally with my changes
28+
- [ ] I have added tests that prove my fix is effective or that my feature works.
29+
- [ ] I have added necessary documentation (if appropriate)
30+
31+
## Further comments
32+
33+
If this is a relatively large or complex change, kick off the discussion by
34+
explaining why you chose the solution you did and what alternatives you
35+
considered, etc...

‎.github/SUPPORT.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Please note this issue tracker is not a help forum. We recommend using [StackOverflow](https://stackoverflow.com/questions/tagged/athennaio) or [Discord channel](https://discord.gg/JdEbBAKw6X) for questions.
2+
3+
<!-- Love Athenna? Please consider supporting our collective: 👉 https://opencollective.com/athennaio/donate -->

0 commit comments

Comments
 (0)