Skip to content

Commit 25f44db

Browse files
Bit-MaximumBit-Maximum
committed
feat(github): Add comprehensive GitHub repository configuration and templates
1 parent cf5527b commit 25f44db

14 files changed

Lines changed: 730 additions & 0 deletions

‎.github/CONTRIBUTING.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# **Contributing**
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, chat, or any other method with the owners of this repository before making a change.
5+
6+
## Git Flow
7+
8+
The project uses the Git Flow branching model. The main branches are `main` and `develop`. The `main` branch is the production-ready branch, and the `develop` branch is the integration branch.
9+
10+
The branches are used as follows:
11+
12+
* From Feature to Feature: squash and merge
13+
* From Feature to Develop: squash and merge
14+
* From Develop to Main: fast-forward merge
15+
* From Main to Develop: fast-forward merge
16+
* From Hotfix to Main: fast-forward merge
17+
18+
It's important to follow this flow to keep the project organized and to avoid conflicts.
19+
20+
Every time a feature is merged into the `main` branch, a new release should be created with the version number following the [Semantic Versioning](https://semver.org/) guidelines.
21+
22+
Also, the project uses pre-commit hooks to ensure the code quality. You should install them with `pre-commit install`.
23+
24+
## Commits
25+
26+
The project uses the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. This is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history. This convention dovetails with [SemVer](https://semver.org/), by describing the features, fixes, and breaking changes made in commit messages.
27+
28+
Each commit message should be conceptually unique and should be able to be understood by itself. It should only contain changes related to the name of the commit. If you need to make a commit with multiple changes that are independent (conceptually), you should split it into multiple commits.
29+
30+
## Pull Request Process
31+
32+
### Features
33+
34+
1. Create your Feature Branch (`git checkout feature/{issue-number}-AmazingFeature`)
35+
2. Check that you have installed pre-commit hooks with `pre-commit install`.
36+
3. Check that your branch is up to date with `git pull` and merge if it's necessary with `git merge origin develop`.
37+
4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
38+
5. Push to the Branch (`git push`)
39+
6. Open a Pull Request to the `develop` branch or to the main epic branch if there's one defined.
40+
41+
### Bug Fixes
42+
43+
Same as Features, but the branch name should be `bugfix/{issue-number}-FixingSomething`.
44+
45+
### Hotfixes
46+
47+
Same as Features, but the branch name should be `hotfix/{issue-number}-FixingSomething`. And the Pull Request should be opened to the `main` branch.
48+
49+
## Issue Report Process
50+
51+
1. Go to the project's issues.
52+
2. Select the template that better fits your issue.
53+
3. Read the instructions carefully and write within the template guidelines.
54+
4. Submit it and wait for support.
55+
56+
## GitHub Projects
57+
58+
You can use GitHub Projects to manage the project's tasks. It's a good way to keep track of the issues and pull requests.

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
2+
3+
Oh, hi there! 😄
4+
5+
To make our work more accessible, we recommend you to choose any of our available issue templates rather than using (this) a blank template.
6+
7+
To expedite issue processing, please search open and closed issues before submitting a new one.
8+
9+
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->
10+
11+
# **Blank Issue Report**
12+
13+
## **Describe the issue**
14+
<!-- A clear and concise description of the problem. -->
15+
16+
*
17+
18+
---
19+
20+
### **Media prove**
21+
<!-- If applicable, add screenshots or videos to help explain your problem. -->
22+
23+
---
24+
25+
### **Your environment**
26+
27+
<!-- use all the applicable bulleted list elements for this specific issue,
28+
and remove all the bulleted list elements that are not relevant for this issue. -->
29+
30+
* OS: <!--[e.g. Ubuntu 5.4.0-26-generic x86_64 / Windows 1904 ...]-->
31+
* Node version:
32+
* Npm version:
33+
* Browser name and version:
34+
35+
---
36+
37+
### **Additional context**
38+
<!-- Add any other context or additional information about the issue here.-->
39+
40+
*

‎.github/ISSUE_TEMPLATE/1-bug-report.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
name: "🐞 Bug Report"
3+
about: "Report an issue to help the project improve."
4+
title: "[Bug] "
5+
labels: "Type: Bug"
6+
7+
---
8+
9+
# **🐞 Bug Report**
10+
11+
## **Describe the bug**
12+
<!-- A clear and concise description of what the bug is. -->
13+
14+
*
15+
16+
---
17+
18+
### **Is this a regression?**
19+
<!-- Did this behaviour used to work in the previous version? -->
20+
<!-- Yes, the last version in which this bug was not present was: ... -->
21+
22+
---
23+
24+
### **To Reproduce**
25+
26+
<!-- Steps to reproduce the error:
27+
(e.g.:)
28+
1. Use x argument / navigate to
29+
2. Fill this information
30+
3. Go to...
31+
4. See error -->
32+
33+
<!-- Write the steps here (add or remove as many steps as needed)-->
34+
35+
1.
36+
2.
37+
3.
38+
4.
39+
40+
---
41+
42+
### **Expected behaviour**
43+
<!-- A clear and concise description of what you expected to happen. -->
44+
45+
*
46+
47+
---
48+
49+
### **Media prove**
50+
<!-- If applicable, add screenshots or videos to help explain your problem. -->
51+
52+
---
53+
54+
### **Your environment**
55+
56+
<!-- use all the applicable bulleted list elements for this specific issue,
57+
and remove all the bulleted list elements that are not relevant for this issue. -->
58+
59+
* OS: <!--[e.g. Ubuntu 5.4.0-26-generic x86_64 / Windows 1904 ...]-->
60+
* Node version:
61+
* Npm version:
62+
* Browser name and version:
63+
64+
---
65+
66+
### **Additional context**
67+
<!-- Add any other context or additional information about the problem here.-->
68+
69+
*
70+
71+
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
72+
73+
Oh, hi there! 😄
74+
75+
To expedite issue processing, please search open and closed issues before submitting a new one.
76+
77+
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->

‎.github/ISSUE_TEMPLATE/2-failing-test.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: "💉 Failing Test"
3+
about: "Report failing tests or CI jobs."
4+
title: "[Test] "
5+
labels: "Type: Test"
6+
7+
---
8+
9+
# **💉 Failing Test**
10+
11+
## **Which jobs/test(s) are failing**
12+
<!-- The CI jobs or tests that are failing -->
13+
14+
*
15+
16+
---
17+
18+
## **Reason for failure/description**
19+
<!-- Try to describe why the test is failing or what we are missing to make it pass. -->
20+
21+
---
22+
23+
### **Media prove**
24+
<!-- If applicable, add screenshots or videos to help explain your problem. -->
25+
26+
---
27+
28+
### **Additional context**
29+
<!-- Add any other context or additional information about the problem here. -->
30+
31+
*
32+
33+
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
34+
35+
Oh, hi there! 😄
36+
37+
To expedite issue processing, please search open and closed issues before submitting a new one.
38+
39+
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->

‎.github/ISSUE_TEMPLATE/3-docs-bug.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: "📚 Documentation or README.md issue report"
3+
about: "Report an issue in the project's documentation or README.md file."
4+
title: ""
5+
labels: "Documentation"
6+
7+
---
8+
# **📚 Documentation Issue Report**
9+
10+
## **Describe the bug**
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
*
14+
15+
---
16+
17+
### **To Reproduce**
18+
19+
<!-- Steps to reproduce the error:
20+
(e.g.:)
21+
1. Use x argument / navigate to
22+
2. Fill this information
23+
3. Go to...
24+
4. See error -->
25+
26+
<!-- Write the steps here (add or remove as many steps as needed)-->
27+
28+
1.
29+
2.
30+
3.
31+
4.
32+
33+
---
34+
35+
### **Media prove**
36+
<!-- If applicable, add screenshots or videos to help explain your problem. -->
37+
38+
---
39+
40+
## **Describe the solution you'd like**
41+
<!-- A clear and concise description of what you want to happen. -->
42+
43+
*
44+
45+
---
46+
47+
### **Additional context**
48+
<!-- Add any other context or additional information about the problem here.-->
49+
50+
*
51+
52+
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
53+
54+
Oh, hi there! 😄
55+
56+
To expedite issue processing, please search open and closed issues before submitting a new one.
57+
58+
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->

‎.github/ISSUE_TEMPLATE/4-feature-request.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: "🚀🆕 Feature Request"
3+
about: "Suggest an idea or possible new feature for this project."
4+
title: ""
5+
labels: "Type: Feature"
6+
7+
---
8+
9+
# **🚀 Feature Request**
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+
*
15+
16+
---
17+
18+
## **Describe the solution you'd like**
19+
<!-- A clear and concise description of what you want to happen. -->
20+
21+
*
22+
23+
---
24+
25+
## **Describe alternatives you've considered**
26+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
27+
28+
*
29+
30+
---
31+
32+
### **Additional context**
33+
<!-- Add any other context or additional information about the problem here.-->
34+
35+
*
36+
37+
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
38+
39+
Oh, hi there! 😄
40+
41+
To expedite issue processing, please search open and closed issues before submitting a new one.
42+
43+
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->

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

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: "🚀➕ Enhancement Request"
3+
about: "Suggest an enhancement for this project. Improve an existing feature"
4+
title: ""
5+
labels: "Type: Enhancement"
6+
7+
---
8+
9+
# **🚀 Enhancement Request**
10+
11+
## **Is your enhancement 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+
*
15+
16+
---
17+
18+
## **Describe the solution you'd like**
19+
<!-- A clear and concise description of what you want to happen. -->
20+
21+
*
22+
23+
---
24+
25+
## **Describe alternatives you've considered**
26+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
27+
28+
*
29+
30+
---
31+
32+
### **Additional context**
33+
<!-- Add any other context or additional information about the problem here.-->
34+
35+
*
36+
37+
<!--📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛
38+
39+
Oh, hi there! 😄
40+
41+
To expedite issue processing, please search open and closed issues before submitting a new one.
42+
43+
📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛📛-->

0 commit comments

Comments
 (0)