Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
name: 🐞 Bug Report
labels: ["bug", "triage"]
title: "[Bug]: "
labels: ["bug", "triage", "new"]
assignees:
- luiz-micci
- peppetwer
Expand All @@ -13,24 +12,23 @@ body:
- type: markdown
attributes:
value: |-
Please read the [troubleshooting section](https://github.com/mfussenegger/nvim-jdtls#troubleshooting) first.
[Please make it easy for people to help you](https://zignar.net/2021/12/03/help-people-help-you-and-put-in-some-effort/)
- type: textarea
id: config
attributes:
label: Cookiecutter Configuration
label: Configuration
description: The configuration you pass to the plugin, if you did it
- type: input
id: version
attributes:
label: Cookiecutter version
label: version
placeholder: 1.0.1
validations:
required: false
- type: textarea
id: repro
attributes:
label: Steps to Reproduce
label: Steps to reproduce
description: How can we see what you're seeing? Please be specific
placeholder: |-
In a project using { gradle version .. | maven .. } (Ideally with link), opening a Java file ...
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question or start a discussion
url: https://github.com/twlabs/Cookiecutter-Templater-for-Backstage/wiki
about: Use the Github discussions feature
url: https://github.com/thoughtworks/templify/wiki
about: Use the Github discussions
8 changes: 3 additions & 5 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
name: 💡 Feature or Enhancement Request
labels: ["feature", "enhancement"]
title: "[Feature]: "
labels: ["feature", "enhancement", "new"]
assignees:
- luiz-micci
- peppetwer

description: Tell us about a problem you'd like to solve using the Cookiecutter templater Plugin
description: Tell us about a problem you'd like to solve
body:
- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem could Cookiecutter Templater solve that it doesn't?
description: What problem could it solve that it doesn't?
validations:
required: true
- type: textarea
Expand Down
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/issue.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
name: 🔧 Just a issue.
labels: ["issue"]
title: "[Issue]: "
name: 🔧 General Issue
labels: ["issue", "new"]
assignees:
- luiz-micci
- peppetwer
description: Elaborate about your issue.
description: Elaborate about your issue
body:
- type: textarea
attributes:
label: Issue description
label: Description
id: desc
validations:
required: true
Expand Down
6 changes: 6 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Make sure these boxes are checked before submitting your pull request:

- [ ] Add tests and IT when implementing or updating a test runner
- [ ] Update the README/Wiki accordingly
- [ ] All mutations have killed
- [ ] All tests have passed
64 changes: 41 additions & 23 deletions CONTRIBUTION.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,67 @@
# Contribution

## Install
## Requirements

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

## How to contribute
## Install and Testing Locally

### 1. Clone the repository
`mvn clean install`

Now clone the repository from GitHub to your computer.
The project uses JUnit with Mutation tests and IT tests.

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

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

```
git checkout -b <add-your-new-branch-name>
```
### Unit Tests

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

```
git checkout -b add-alonzo-church
```
### Integration Tests

### 3. Commit your changes
1. Make sure to add your project scenario to the `resources-it` folder.
2. Include your IT scenario in the class `TemplifyIT`. (This class is responsible for executing the Maven plugin build for the project scenarios)
3. Ensure the tests are marked as `@MavenTest` and have meaningful asserts.

If you face any issue about the

## How to contribute

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.
### 1. Fork and clone this repository.

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

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:
### 2. Create a branch to add your changes

```
git add Contributors.md
git switch -C <add-your-new-branch-name>
```

Now commit those changes using the `git commit` command:
For example:

```
git commit -m "Add <your-name> to Contributors list"
git switch -C update-readme
```

Replacing `<your-name>` with your name.
### 3. Commit your changes

This repository uses the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.

For example:
-
```
git commit -m "feat: add new feature"
git commit -m "docs: correct spelling of CHANGELOG"
git commit -m "feat(api)!: send an email to the customer when a product is shipped"

```

### 4. Push to the original branch

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

Congrats!

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

## Architecture



```mermaid
---
title: Plugin Architecture
Expand Down
Loading