Skip to content

Commit 5a7e51a

Browse files
committed
Update repository metadata: templates and contributing
1 parent 642df85 commit 5a7e51a

File tree

3 files changed

+73
-18
lines changed

3 files changed

+73
-18
lines changed
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Level
11+
**CRITICAL / MAJOR / MINOR**
12+
13+
## Environment
14+
* AutoParallel version
15+
* COMPSs version
16+
* PLUTO version
17+
* Java / Python / C version
18+
* Operating System
19+
20+
## Description
21+
A few sentences describing the overall bug.
22+
23+
## Minimal example to reproduce
24+
Minimal and complete example to reproduce the bug.
25+
26+
## Exception
27+
Exception/error obtained.
28+
29+
## Expected behaviour
30+
Description of the expected behaviour.

CONTRIBUTING.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,4 @@ with the project.
2121
developers, or if you do not have permission to do that, you may request the
2222
second reviewer to merge it for you.
2323

24-
25-
## Attribution
26-
27-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
28-
available at [http://contributor-covenant.org/version/1/4][version]
29-
3024
[sem_version]: http://semver.org/
31-
[homepage]: http://contributor-covenant.org
32-
[version]: http://contributor-covenant.org/version/1/4/

PULL_REQUEST_TEMPLATE.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,36 @@
1-
## Status
1+
---
2+
name: Pull Request template
3+
about: Describe the changes of a Pull Request you want to merge.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
# Status
211
**READY / WORK IN PROGRESS / HOLD**
312

4-
## Migrations
5-
YES | NO
613

7-
## Description
8-
A few sentences describing the overall goals of the pull request's commits.
14+
# Description
15+
16+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
17+
18+
Fixes #(issue_number)
919

1020
## Project impact
1121
List the general project components that this PR will affect:
1222

1323
*
1424

25+
## Type of change
26+
27+
Please delete options that are not relevant.
28+
29+
- [ ] Bug fix (non-breaking change which fixes an issue)
30+
- [ ] New feature (non-breaking change which adds functionality)
31+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
32+
- [ ] This change requires a documentation update
33+
1534
## Related PRs
1635
List related PRs against other branches:
1736

@@ -21,14 +40,28 @@ other_pr_production | [link]()
2140
other_pr_master | [link]()
2241

2342

24-
## Todos
25-
- [ ] Tests
26-
- [ ] Documentation
43+
# How Has This Been Tested?
2744

45+
Please describe the tests that you ran to verify your changes. If you haven't added any test and it is relevant provide instructions so we can reproduce.
2846

29-
## Steps to Test or Reproduce
30-
Outline the steps to test or reproduce the PR here.
47+
- [ ] I have added a new test
48+
- [ ] I have modified a test to check this
49+
50+
Reproduce instructions:
3151

3252
```bash
3353
git checkout <feature_branch>
3454
```
55+
56+
57+
# Checklist:
58+
59+
- [ ] My code follows the style guidelines of this project
60+
- [ ] I have performed a self-review of my own code
61+
- [ ] I have commented my code, particularly in hard-to-understand areas
62+
- [ ] I have made corresponding changes to the documentation
63+
- [ ] New and existing unit tests pass locally with my changes
64+
- [ ] I have run the script to add headers if new files are present (i.e. `utils/scripts/header_setup/replace_all.sh`)
65+
- [ ] I have rebased my branch before trying to merge.
66+
67+

0 commit comments

Comments
 (0)