Skip to content

Commit 1b48407

Browse files
followynnefollowynne
authored
chore: update readme and repo guidelines (#76)
1 parent b1af7ea commit 1b48407

File tree

12 files changed

+272
-243
lines changed

12 files changed

+272
-243
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
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+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.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_request.md‎

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.

‎.github/workflows/DotNET-build.yml‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,8 @@ jobs:
4747
SonarToken: ${{ secrets.SONAR_TOKEN }}
4848
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4949

50-
- uses: phoenix-actions/test-reporting@v9
50+
- uses: actions/upload-artifact@v2
5151
if: always()
5252
with:
53-
name: DotNET - Tests
54-
output-to: checks
53+
name: test-results
5554
path: '**/test-results.trx'
56-
reporter: dotnet-trx
57-
fail-on-error: false

‎.github/workflows/DotNET-reporting-on-build.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: DotNET Test Reporting
2+
3+
# read-write repo token
4+
# access to secrets
5+
on:
6+
workflow_run:
7+
workflows: ['DotNET-build']
8+
types:
9+
- completed
10+
11+
jobs:
12+
upload:
13+
runs-on: ubuntu-latest
14+
if: >
15+
github.event.workflow_run.event == 'pull_request' &&
16+
github.event.workflow_run.conclusion == 'success'
17+
steps:
18+
- uses: phoenix-actions/test-reporting@v9
19+
with:
20+
artifact: test-results # artifact name
21+
name: DotNET - Tests # Name of the check run which will be created
22+
path: '**/test-results.trx' # Path to test results (inside artifact .zip)
23+
reporter: dotnet-trx # Format of test results
24+
output-to: checks

‎.github/workflows/JS-build.yml‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,25 +49,22 @@ jobs:
4949

5050
- name: SonarCloud run
5151
uses: SonarSource/sonarcloud-github-action@master
52-
if: ${{ false }}
52+
if: needs.pr-check.outputs.number == 'null'
5353
env:
5454
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
5555
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN_UI }}
5656
with:
5757
args: >
58-
-Dsonar.organization=
59-
-Dsonar.projectKey=
58+
-Dsonar.organization=followynne
59+
-Dsonar.projectKey=followynne_serilog-ui_assets
6060
-Dsonar.sources=src/Serilog.Ui.Web/assets/
6161
-Dsonar.tests=src/Serilog.Ui.Web/assets/
6262
-Dsonar.exclusions=src/Serilog.Ui.Web/assets/__tests__/**/*
6363
-Dsonar.test.inclusions=src/Serilog.Ui.Web/assets/__tests__/**/*
6464
-Dsonar.javascript.lcov.reportPaths=./src/Serilog.Ui.Web/coverage/lcov.info
6565
66-
- uses: phoenix-actions/test-reporting@v9
66+
- uses: actions/upload-artifact@v2
6767
if: always()
6868
with:
69-
name: JS - Tests
70-
output-to: checks
69+
name: test-results
7170
path: '**/jest-*.xml'
72-
reporter: jest-junit
73-
fail-on-error: false

‎.github/workflows/JS-reporting-on-build.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: JS Test Reporting
2+
3+
# read-write repo token
4+
# access to secrets
5+
on:
6+
workflow_run:
7+
workflows: ['JS-build']
8+
types:
9+
- completed
10+
11+
jobs:
12+
upload:
13+
runs-on: ubuntu-latest
14+
if: >
15+
github.event.workflow_run.event == 'pull_request' &&
16+
github.event.workflow_run.conclusion == 'success'
17+
steps:
18+
- uses: phoenix-actions/test-reporting@v9
19+
with:
20+
artifact: test-results # artifact name
21+
name: JS - Tests # Name of the check run which will be created
22+
path: '**/jest-*.xml' # Path to test results (inside artifact .zip)
23+
reporter: jest-junit # Format of test results
24+
output-to: checks

‎.github/workflows/Release.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,14 +78,14 @@ jobs:
7878

7979
- name: SonarCloud run
8080
uses: SonarSource/sonarcloud-github-action@master
81-
if: ${{ false }}
81+
if: needs.pr-check.outputs.number == 'null'
8282
env:
8383
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
8484
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN_UI }}
8585
with:
8686
args: >
87-
-Dsonar.organization=
88-
-Dsonar.projectKey=
87+
-Dsonar.organization=followynne
88+
-Dsonar.projectKey=followynne_serilog-ui_assets
8989
-Dsonar.sources=src/Serilog.Ui.Web/assets/
9090
-Dsonar.tests=src/Serilog.Ui.Web/assets/
9191
-Dsonar.exclusions=src/Serilog.Ui.Web/assets/__tests__/**/*

‎CONTRIBUTING.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
## Issues
4+
5+
Issues are very valuable to this project.
6+
7+
- Ideas are a valuable source of contributions others can make
8+
- Problems show where this project is lacking
9+
- With a question you show where contributors can improve the user
10+
experience
11+
12+
Thank you for creating them.
13+
14+
The project mantainers will try to answer you as soon as possible, please be patient while waiting for an answer 🙂
15+
16+
When possible, use the available templates to write your ideas.
17+
18+
## Pull Requests
19+
20+
Pull requests are a great way to get your features/fix into this repository.
21+
22+
Anyone is more than welcome to propose changes to the source code; the maintainers will try to follow up and review the proposal. After the changes are reviewed and approved, the PR will be merged.
23+
24+
Keep in mind that a Pull Request, to be merged, needs to respect the following things:
25+
26+
### State intent
27+
28+
It should be clear which problem you're trying to solve with your
29+
contribution.
30+
31+
Please include a detailed description of what you want to achieve, to help the reviewers understand the context of your work 🤝.
32+
33+
### Be of good quality
34+
35+
- There are no spelling mistakes 📶
36+
- It reads well 📖
37+
- Repository style is followed ⛏️
38+
39+
### Prepare wiki/README contribution 📋
40+
41+
The project has a wiki where are stored detailed information on how to use the package.
42+
43+
Please keep in mind that it's nice to included, in the description or in a separate comment, the .md content that can be added to the wiki.
44+
45+
With this addtion, reviewers will be able to plan the feature presentation to the end users.
46+
47+
# Attribution
48+
49+
> The Contributing template was adapted from:
50+
>
51+
> [github/PurpleBooth/a-good-readme-template]([https://gist.github.com/PurpleBooth/b24679402957c63ec426](https://github.com/PurpleBooth/a-good-readme-template/blob/main/CONTRIBUTING.md))

0 commit comments

Comments
 (0)