Skip to content

Commit 0b0607a

Browse files
committed
added .github folder
1 parent 36af10b commit 0b0607a

File tree

6 files changed

+156
-2
lines changed

6 files changed

+156
-2
lines changed

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: "Bug Report"
2+
description: Create a new ticket for a bug.
3+
title: "[BUG] - <title>"
4+
labels: [
5+
"bug"
6+
]
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: "Description"
12+
description: Please enter an explicit description of your issue.
13+
placeholder: Short and explicit description of your incident.
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: reprod
18+
attributes:
19+
label: "Reproduction steps"
20+
description: Please enter an explicit description of your issue.
21+
value: |
22+
1. Go to '...'
23+
2. Click on '....'
24+
3. See error
25+
...
26+
render: bash
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: screenshot
31+
attributes:
32+
label: "Screenshots"
33+
description: If applicable, add screenshots to help explain your problem.
34+
render: bash
35+
validations:
36+
required: false
37+
- type: textarea
38+
id: logs
39+
attributes:
40+
label: "Logs"
41+
description: Please copy and paste any relevant log output.
42+
render: bash
43+
validations:
44+
required: false
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: "Feature Request"
2+
description: Create a new ticket for a new feature request
3+
title: "[REQUEST] - <title>"
4+
labels: [
5+
"question"
6+
]
7+
body:
8+
- type: textarea
9+
id: summary
10+
attributes:
11+
label: "Summary"
12+
description: Provide a brief explanation of the feature.
13+
placeholder: Describe in a few lines your feature request.
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: basic_example
18+
attributes:
19+
label: "Basic Example"
20+
description: Indicate here some basic examples of your feature.
21+
placeholder: A few specific words about your feature request.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: drawbacks
26+
attributes:
27+
label: "Why"
28+
description: Why you want to see this feature added?
29+
placeholder: How would this feature be benefitial for Machine.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: unresolved_question
34+
attributes:
35+
label: "Unresolved questions"
36+
description: What questions still remain unresolved?
37+
placeholder: Identify any unresolved issues.
38+
validations:
39+
required: false

.github/assets/social_banner.png

882 KB
Loading

.github/pull_request_template.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
**PLEASE REMOVE THIS PART BEFORE SUBMITTING YOUR PR**
2+
3+
Please, go through these steps before you submit a PR.
4+
5+
1. Make sure that your PR is not a duplicate.
6+
2. If not, then make sure that:
7+
- You have done your changes in a separate branch.
8+
- You have a descriptive commit message with a short title (first line).
9+
- You have only one commit (if not, squash them into one commit).
10+
- You follow contributing guide lines; [CONTRIBUTING.md](../CONTRIBUTING.md) and [STYLE_GUIDE.md](../STYLE_GUIDE.md).
11+
- Tests don't throw any error. If they do, fix them first.
12+
- Check style doesn't throw any error. If it does fix the style of the code.
13+
- Header is part of all code files (for java files this is done automatically when project is built).
14+
15+
3. **After** these steps, you're ready to open a pull request.
16+
- Give a descriptive title to your PR.
17+
- Describe your changes, use following template.
18+
- Put `closes #XXXX` in your comment fixed specific issue.
19+
20+
**PLEASE USE THIS TEMPLATE FOR YOUR PR**
21+
22+
**What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)
23+
24+
25+
**What is the current behavior?** (You can also link to an open issue here)
26+
27+
28+
**What is the new behavior?** (If this is a feature change)
29+
30+
31+
**Does this PR introduce a breaking change?** (What changes might users need to make due to this PR?)
32+
33+
34+
**Other information**: (Remove if empty)
35+
36+
37+
* [ ] I follow Machine contributing guidelines

.github/workflows/tests.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Build and test Machine
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
build:
11+
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v3
16+
- name: Set up JDK 17
17+
uses: actions/setup-java@v3
18+
with:
19+
distribution: 'adopt'
20+
java-version: 17
21+
cache: gradle
22+
- name: Grant execute permission for gradlew
23+
run: chmod +x gradlew
24+
- name: Build Machine
25+
run: ./gradlew buildAll
26+
- name: Upload Nightly Build
27+
uses: actions/upload-artifact@v3
28+
if: success()
29+
with:
30+
name: Machine
31+
path: build/libs/*.jar

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ much appreciated!
1111

1212
### General Information
1313
- Adhere to the project's style guide, which is comprehensively
14-
described in the `STYLE_GUIDE.md` file.
14+
described in the [STYLE_GUIDE.md](STYLE_GUIDE.md) file.
1515
- Test your modifications carefully, make sure they don't cause
1616
side effects that may cause unintentional behaviour.
1717
- Contributions must not include any malicious code intended to cause harm to
@@ -66,14 +66,17 @@ When designing implementations, ensure that you:
6666
such as unexpected exceptions.
6767

6868
### Licensing
69-
In order to contribute code, it must be licensed under **GPLv3**;
69+
In order to contribute code, it must be licensed under [**GPLv3**](LICENSE);
7070
it is either your property, or you have express permission to provide
7171
and license it to us.
7272

7373
Third-party code may be accepted in the following circumstances:
7474
- It is under a compatible license and part of a public, freely-available resource.
7575
- You have been granted permission to include it.
7676

77+
All code files should start with the [Machine project header](HEADER.txt).
78+
For Java files, this is done automatically when the project is built.
79+
7780
### Lombok
7881
Throughout the project, we use [Lombok](https://projectlombok.org/)
7982
to minimize boilerplate code and improve its readability.

0 commit comments

Comments
 (0)