Skip to content

Commit 8299e8a

Browse files
yp969803yp969803
committed
feat: markdowns
1 parent 61413b5 commit 8299e8a

File tree

9 files changed

+330
-6
lines changed

9 files changed

+330
-6
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
2+
name: Bug Report
3+
title: "[Bug] Bug title "
4+
description: Create a report to help us identify any unintended flaws, errors, or faults.
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Before Creating the Bug Report
9+
options:
10+
- label: >
11+
I found a bug, not just asking a question, which should be created in [GitHub Discussions](https://github.com/mdgspace/activity-leaderboard-backend/discussions).
12+
required: true
13+
- label: >
14+
I have searched the [GitHub Issues](https://github.com/mdgspace/activity-leaderboard-backend/issues) and [GitHub Discussions](https://github.com/mdgspace/activity-leaderboard-backend/discussions) of this repository and believe that this is not a duplicate.
15+
required: true
16+
- label: >
17+
I have confirmed that this bug belongs to the current repository, not other repositories of RocketMQ.
18+
required: true
19+
20+
- type: textarea
21+
attributes:
22+
label: Runtime platform environment
23+
description: Describe the runtime platform environment.
24+
placeholder: >
25+
OS: (e.g., "Ubuntu 20.04")
26+
OS: (e.g., "Windows Server 2019")
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
attributes:
32+
label: Backend version
33+
description: Describe the Backend version.
34+
placeholder: >
35+
branch: (e.g main)
36+
version: (e.g. 1.0.0)
37+
Git commit id: (e.g. c88b5cfa72e204962929eea105687647146112c6)
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
attributes:
43+
label: JDK Version
44+
description: Run or Compiler version.
45+
placeholder: >
46+
Compiler: (e.g., "Oracle JDK 11.0.17")
47+
OS: (e.g., "Ubuntu 20.04")
48+
Runtime (if different from JDK above): (e.g., "Oracle JRE 8u251")
49+
OS (if different from OS compiled on): (e.g., "Windows Server 2019")
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
attributes:
55+
label: Describe the Bug
56+
description: Describe what happened.
57+
placeholder: >
58+
A clear and concise description of what the bug is.
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
attributes:
64+
label: Steps to Reproduce
65+
description: Describe the steps to reproduce the bug here.
66+
placeholder: >
67+
If possible, provide a recipe for reproducing the error.
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
attributes:
73+
label: What Did You Expect to See?
74+
description: You expect to see result.
75+
placeholder: >
76+
A clear and concise description of what you expected to see.
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
attributes:
82+
label: What Did You See Instead?
83+
description: You instead to see result.
84+
placeholder: >
85+
A clear and concise description of what you saw instead.
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
attributes:
91+
label: Additional Context
92+
description: Additional context.
93+
placeholder: >
94+
Add any other context about the problem here.
95+
validations:
96+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
3+
blank_issues_enabled: false
4+
contact_links:
5+
- name: Ask Question
6+
url: https://github.com/mdgspace/activity-leaderboard-backend/discussions
7+
about: Please go to GitHub Disccusions to ask questions

‎.github/ISSUE_TEMPLATE/doc.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
2+
name: Documentation Related
3+
title: "[Doc] Documentation Related "
4+
description: I find some issues related to the documentation.
5+
labels: [ "module/doc" ]
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Search before creation
10+
description: >
11+
Please make sure to search in the [issues](https://github.com/mdgspace/activity-leaderboard-backend/issues)
12+
first to see whether the same issue was reported already.
13+
options:
14+
- label: >
15+
I had searched in the [issues](https://github.com/mdgspace/activity-leaderboard-backend/issues) and found
16+
no similar issues.
17+
required: true
18+
19+
- type: textarea
20+
attributes:
21+
label: Documentation Related
22+
description: Describe the suggestion about document.
23+
placeholder: >
24+
e.g There is a typo
25+
validations:
26+
required: true
27+
28+
- type: checkboxes
29+
attributes:
30+
label: Are you willing to submit PR?
31+
description: >
32+
This is absolutely not required, but we are happy to guide you in the contribution process
33+
especially if you already have a good understanding of how to implement the fix.
34+
options:
35+
- label: Yes I am willing to submit a PR!
36+
37+
- type: markdown
38+
attributes:
39+
value: "Thanks for completing our form!"

‎.github/ISSUE_TEMPLATE/enhancement_request.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
2+
3+
name: Enhancement Request
4+
title: "[Enhancement] Enhancement title"
5+
description: Suggest an enhancement for this project
6+
labels: [ "type/enhancement" ]
7+
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Before Creating the Enhancement Request
11+
description: >
12+
Most of issues should be classified as bug or feature request. An issue should be considered as an enhancement when it proposes improvements to
13+
existing functionality or user experience, without necessarily introducing new features or fixing existing bugs.
14+
options:
15+
- label: >
16+
I have confirmed that this should be classified as an enhancement rather than a bug/feature.
17+
required: true
18+
19+
- type: textarea
20+
attributes:
21+
label: Summary
22+
placeholder: >
23+
A clear and concise description of the enhancement you would like to see in the project.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
attributes:
29+
label: Motivation
30+
placeholder: >
31+
Explain why you believe this enhancement is necessary, and how it benefits the project and community.
32+
Include any specific use cases that you have in mind.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: Describe the Solution You'd Like
39+
placeholder: >
40+
Describe the enhancement you propose, detailing the change and implementation steps involved.
41+
If you have multiple solutions, please list them separately.
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
attributes:
47+
label: Describe Alternatives You've Considered
48+
placeholder: >
49+
List any alternative enhancements or implementations you have considered, and explain why they may not be as effective or appropriate.
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
attributes:
55+
label: Additional Context
56+
placeholder: >
57+
Add any relevant context, screenshots, prototypes, or other supplementary information to help illustrate the enhancement.
58+
validations:
59+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
name: Feature Request
3+
title: "[Feature] New feature title"
4+
description: Suggest an idea for this project.
5+
labels: [ "type/new feature" ]
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Is Your Feature Request Related to a Problem?
10+
description: Please Describe It.
11+
placeholder: >
12+
A clear and concise description of what the problem is.
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
attributes:
18+
label: Describe the Solution You'd Like
19+
description: Describe how you solved it.
20+
placeholder: >
21+
A clear and concise description of what you want to happen.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
attributes:
27+
label: Describe Alternatives You've Considered
28+
description: Describe your solution
29+
placeholder: >
30+
A clear and concise description of any alternative solutions or features you've considered.
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
attributes:
36+
label: Additional Context
37+
description: Additional context.
38+
placeholder: >
39+
Add any other context about the problem here.
40+
validations:
41+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Please make sure the target branch is right. In most case, the target branch should be `develop`. -->
2+
3+
### Which Issue(s) This PR Fixes
4+
5+
<!-- Please ensure that the related issue has already been created, and [link this pull request to that issue using keywords](<https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword>) to ensure automatic closure. -->
6+
7+
Fixes #issue_id
8+
9+
### Brief Description
10+
11+
<!-- Write a brief description for your pull request to help the maintainer understand the reasons behind your changes. -->
12+
13+
### How Did You Test This Change?
14+
15+
<!-- In order to ensure the code quality of Apache RocketMQ, we expect every pull request to have undergone thorough testing. -->

‎DEPLOYMENT.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Deployment Guide
2+
3+
## Prerequisites
4+
- [Git](https://git-scm.com/downloads)
5+
- [Docker](https://docs.docker.com/engine/install/)
6+
- [MultiAvatar api secret Key](https://api.multiavatar.com/)
7+
- [Github OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)
8+
9+
## Steps
10+
11+
### Clone the repo
12+
```
13+
git clone https://github.com/mdgspace/activity-leaderboard.git
14+
15+
cd activity-leaderboard
16+
```
17+
18+
### Create .env using .env.example
19+
20+
### Run docker-compose
21+
```
22+
docker compose up -d
23+
```

‎DEVELOPMENT.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Deployment Guide
2+
3+
## Prerequisites
4+
- [Git](https://git-scm.com/downloads)
5+
- [Docker](https://docs.docker.com/engine/install/)
6+
- [nodejs](https://nodejs.org/en/download)
7+
- [MultiAvatar api secret Key](https://api.multiavatar.com/)
8+
- [Github OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)
9+
10+
## Steps
11+
12+
### Clone the repo
13+
```
14+
git clone https://github.com/mdgspace/activity-leaderboard.git
15+
16+
cd activity-leaderboard
17+
```
18+
19+
### Create .env using .env.example
20+
21+
### Run
22+
1. `npm ci`
23+
2. `npm run prepare`
24+
3. `npm run lint`
25+
4. `npm run prettier`
26+
27+
### Run appplication
28+
29+
```
30+
npm start
31+
```

‎README.md‎

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
1-
# Activity Leaderboard
1+
# Activity-leaderboard Frontend
22

3-
## Setup
3+
### Activity Leader Board is a open source project which can be used to monitor progress in an Organization .
44

5-
1. `npm ci`
6-
2. `npm run prepare`
7-
3. `npm run lint`
8-
4. `npm run prettier`
5+
6+
7+
## Tech Stack
8+
9+
**Backend:** SpringBoot
10+
11+
**Frontend:** React
12+
13+
**Cloud:** AWS
14+
15+
**Database**: Postgres
16+
17+
**Caching**: Redis
18+
19+
20+
### Activity-leaderboard Backend
21+
[Backend](https://github.com/mdgspace/activity-leaderboard.git)

0 commit comments

Comments
 (0)