Skip to content

Commit f43b3b5

Browse files
GiuseppeMPLuiz-Micci
GiuseppeMP
and
Luiz-Micci
authored
Update CONTRIBUTION.md details (#45)
* docs(CONTRIBUTION.md): Add fork and PR instructions. * docs(CONTRIBUTION.md): add requirements and test instructions * docs(issue_template): remove Cookiecutter mentions and typo * docs(issue_template): typo * docs(pull_request_template.md): add initial version * Rename CONTRIBUTION.md to CONTRIBUTING.md --------- Co-authored-by: Micci - Luiz Miccieli <[email protected]>
1 parent ba3e5dd commit f43b3b5

File tree

6 files changed

+60
-41
lines changed

6 files changed

+60
-41
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
name: 🐞 Bug Report
3-
labels: ["bug", "triage"]
4-
title: "[Bug]: "
3+
labels: ["bug", "triage", "new"]
54
assignees:
65
- luiz-micci
76
- peppetwer
@@ -13,24 +12,23 @@ body:
1312
- type: markdown
1413
attributes:
1514
value: |-
16-
Please read the [troubleshooting section](https://github.com/mfussenegger/nvim-jdtls#troubleshooting) first.
1715
[Please make it easy for people to help you](https://zignar.net/2021/12/03/help-people-help-you-and-put-in-some-effort/)
1816
- type: textarea
1917
id: config
2018
attributes:
21-
label: Cookiecutter Configuration
19+
label: Configuration
2220
description: The configuration you pass to the plugin, if you did it
2321
- type: input
2422
id: version
2523
attributes:
26-
label: Cookiecutter version
24+
label: version
2725
placeholder: 1.0.1
2826
validations:
2927
required: false
3028
- type: textarea
3129
id: repro
3230
attributes:
33-
label: Steps to Reproduce
31+
label: Steps to reproduce
3432
description: How can we see what you're seeing? Please be specific
3533
placeholder: |-
3634
In a project using { gradle version .. | maven .. } (Ideally with link), opening a Java file ...

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
blank_issues_enabled: false
33
contact_links:
44
- name: Ask a question or start a discussion
5-
url: https://github.com/twlabs/Cookiecutter-Templater-for-Backstage/wiki
6-
about: Use the Github discussions feature
5+
url: https://github.com/thoughtworks/templify/wiki
6+
about: Use the Github discussions

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
name: 💡 Feature or Enhancement Request
2-
labels: ["feature", "enhancement"]
3-
title: "[Feature]: "
2+
labels: ["feature", "enhancement", "new"]
43
assignees:
54
- luiz-micci
65
- peppetwer
7-
8-
description: Tell us about a problem you'd like to solve using the Cookiecutter templater Plugin
6+
description: Tell us about a problem you'd like to solve
97
body:
108
- type: textarea
119
id: problem
1210
attributes:
1311
label: Problem Statement
14-
description: What problem could Cookiecutter Templater solve that it doesn't?
12+
description: What problem could it solve that it doesn't?
1513
validations:
1614
required: true
1715
- type: textarea

‎.github/ISSUE_TEMPLATE/issue.yml‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
name: 🔧 Just a issue.
2-
labels: ["issue"]
3-
title: "[Issue]: "
1+
name: 🔧 General Issue
2+
labels: ["issue", "new"]
43
assignees:
54
- luiz-micci
65
- peppetwer
7-
description: Elaborate about your issue.
6+
description: Elaborate about your issue
87
body:
98
- type: textarea
109
attributes:
11-
label: Issue description
10+
label: Description
1211
id: desc
1312
validations:
1413
required: true

‎.github/pull_request_template.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Make sure these boxes are checked before submitting your pull request:
2+
3+
- [ ] Add tests and IT when implementing or updating a test runner
4+
- [ ] Update the README/Wiki accordingly
5+
- [ ] All mutations have killed
6+
- [ ] All tests have passed

‎CONTRIBUTION.md‎ renamed to ‎CONTRIBUTING.md‎

Lines changed: 41 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,67 @@
11
# Contribution
22

3-
## Install
3+
## Requirements
44

5-
This project uses a Makefile to run scripts. You can run `make help` to get the list of commands.
5+
1. Maven 3.9.6+
6+
2. Java JDK 11
67

7-
## How to contribute
8+
## Install and Testing Locally
89

9-
### 1. Clone the repository
10+
`mvn clean install`
1011

11-
Now clone the repository from GitHub to your computer.
12+
The project uses JUnit with Mutation tests and IT tests.
1213

13-
### 2. Create a branch
14+
1. [Jupiter aka Junit5](https://junit.org/junit5/)
15+
2. [PIT](https://pitest.org/)
16+
3. [Maven IT extenstion](https://github.com/khmarbaise/maven-it-extension)
1417

15-
This repository not supports forking. So, create a branch named accord what you want to contribute to.
18+
Before adding new code, make sure to add test cases for it so that the maintainers can provide guidance and simulate the same scenarios.
1619

17-
```
18-
git checkout -b <add-your-new-branch-name>
19-
```
20+
### Unit Tests
2021

21-
For example:
22+
1. They're just conventional JUnit tests.
23+
2. Avoid excessive mocks.
24+
3. Try to use the AAA structure, stands for: Arrange, Act, Assert
25+
4. Ensure all the mutations were killed and covered.
2226

23-
```
24-
git checkout -b add-alonzo-church
25-
```
27+
### Integration Tests
2628

27-
### 3. Commit your changes
29+
1. Make sure to add your project scenario to the `resources-it` folder.
30+
2. Include your IT scenario in the class `TemplifyIT`. (This class is responsible for executing the Maven plugin build for the project scenarios)
31+
3. Ensure the tests are marked as `@MavenTest` and have meaningful asserts.
32+
33+
If you face any issue about the
34+
35+
## How to contribute
2836

29-
Now open `Contributors.md` file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.
37+
### 1. Fork and clone this repository.
3038

39+
https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project
3140

32-
If you go to the project directory and execute the command `git status`, you'll see there are changes. Add those changes to the branch you just created using the `git add` command:
41+
### 2. Create a branch to add your changes
3342

3443
```
35-
git add Contributors.md
44+
git switch -C <add-your-new-branch-name>
3645
```
3746

38-
Now commit those changes using the `git commit` command:
47+
For example:
3948

4049
```
41-
git commit -m "Add <your-name> to Contributors list"
50+
git switch -C update-readme
4251
```
4352

44-
Replacing `<your-name>` with your name.
53+
### 3. Commit your changes
4554

55+
This repository uses the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.
56+
57+
For example:
58+
-
59+
```
60+
git commit -m "feat: add new feature"
61+
git commit -m "docs: correct spelling of CHANGELOG"
62+
git commit -m "feat(api)!: send an email to the customer when a product is shipped"
63+
64+
```
4665

4766
### 4. Push to the original branch
4867

@@ -67,12 +86,11 @@ Soon I'll be merging all your changes into the main branch of this project. You
6786

6887
Congrats!
6988

70-
You just completed the standard `clone -> branch -> commits -> PR_` workflow that you'll often encounter as a contributor!
89+
You just completed the standard `fork/clone -> branch -> commits -> PR_` workflow that you'll often encounter as a contributor!
7190

7291
## Architecture
7392

7493

75-
7694
```mermaid
7795
---
7896
title: Plugin Architecture

0 commit comments

Comments
 (0)