Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update the GitHub templates #33

Merged
merged 2 commits into from
Aug 16, 2024
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
31 changes: 20 additions & 11 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,41 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
title: "[BUG] "
labels: bug
assignees: ''

---

**Describe the bug**
### Describe the bug
A clear and concise description of what the bug is.

**To Reproduce**

### To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**

### Expected behavior
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
### Screenshots
If applicable, add screenshots or videos to help explain your problem.


### Environment
- Desktop or mobile:
- OS and version: [e.g. iOS 14.1]
- Browser and version: [e.g. chrome 118, safari 15]
- Node/npm version (if applicable):
- Used frameworks (if applicable):



**Additional context**
### Additional context
Add any other context about the problem here.

10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEAT]"
title: "[FEAT] "
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
### Describe the solution you'd like
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
### Additional context
Add any other context or screenshots about the feature request here.
46 changes: 46 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<!--
👋 Hi, thanks for sending a Pull Request to a repository of the `Process Analytics` project! 💖
Please fill out all fields below and make sure each item is true and [x] checked.
Otherwise we may not be able to review your PR.

Note: core contributors are not required to use this template.
-->

## PR Checklist

- [ ] Addresses an existing open issue: closes #<the_issue_number_here>.
- [ ] You have discussed this issue with the maintainers of the repository, and you are assigned to the issue.
- [ ] If it exists, steps in the CONTRIBUTING guide (generally described in the `CONTRIBUTING.md` file at the root of the repository) were taken.
- [ ] The PR title follows the ["Conventional Commits"](https://www.conventionalcommits.org/en/v1.0.0/) guidelines.

<!--
The PR title must look like `<type>[optional scope]: <lower case description>`

*type* can be (see existing Pull Request for more elements):
- chore
- docs
- feat
- fix
- refactor
...

If defined, the _optional scope_ must be put in parentheses.

Note: The title is used as proposal for the maintainer merging the Pull Request.
-->


## Overview

<!-- Description of what and why is changed, and how the code change does that. -->
- Explain the **details** for making this change: What existing problem does the Pull Request solve? Why is this feature beneficial?
- If your contribution has altered the BPMN rendering or any other visual feature, add screenshots.
- If the Pull Request includes breaking changes, it must explicitly follow the syntax proposed by [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#specification) (in the PR title and with a quote at this end of this overview).


## Notes

<!-- Use this paragraph to provide the reviewer with any additional information. -->

N/A

8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)

Default community health files for the process-analytics organization.

For usage, the [GitHub documentation](https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file).
This repository includes:
- The source of the [profile](./profile) displayed in the [Process Analytics organization](https://github.com/process-analytics)
- Shared resources for the `Process Analytics` organization.
- Default community health files (templates, ...). For usage, the [GitHub documentation](https://docs.github.com/en/github/building-a-strong-community/creating-a-default-community-health-file).
- Shared configuration (`release-drafter`, ...)