Skip to content

Commit

Permalink
Update: Github config
Browse files Browse the repository at this point in the history
  • Loading branch information
jonnitto committed Sep 28, 2022
1 parent 3e2f4b4 commit b01d1ab
Show file tree
Hide file tree
Showing 8 changed files with 165 additions and 76 deletions.
42 changes: 19 additions & 23 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,34 @@

I love to welcome your contributions. There are several ways to help out:

* Create an [issue](https://github.com/jonnitto/Carbon.Image/issues) on GitHub, if you have found a bug
* Write test cases or provide examples for open bug issues
* Write patches for open bug/feature issues, preferably with test cases included

- Create an [issue](../../../issues) on GitHub, if you have found a bug
- Write test cases or provide examples for open bug issues
- Write patches for open bug/feature issues, preferably with test cases included

There are a few guidelines that I need contributors to follow so that I have a
chance of keeping on top of things.


## Getting Started

* Make sure you have a [GitHub account](https://github.com/signup/free).
* Submit an [issue](https://github.com/jonnitto/Carbon.Image/issues), assuming one does not already exist.
* Clearly describe the issue including steps to reproduce when it is a bug.
* Make sure you fill in the earliest version that you know has the issue.
* Fork the repository on GitHub.
- Make sure you have a [GitHub account](https://github.com/signup/free).
- Submit an [issue](../../../issues), assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Fork the repository on GitHub.

## Making Changes

* Create a topic branch from where you want to base your work.
* This is usually the master branch.
* Only target release branches if you are certain your fix must be on that
branch.
* To quickly create a topic branch based on master; `git branch
master/my_contribution master` then checkout the new branch with `git
checkout master/my_contribution`. Better avoid working directly on the
`master` branch, to avoid conflicts if you pull in updates from origin.
* Make commits of logical units.
* Check for unnecessary whitespace with `git diff --check` before committing.
* Use descriptive commit messages and reference the #issue number.
- Create a topic branch from where you want to base your work.
- This is usually the main branch.
- Only target release branches if you are certain your fix must be on that
branch.
- To quickly create a topic branch based on main; `git branch main/my_contribution main` then checkout the new branch with `git checkout main/my_contribution`. Better avoid working directly on the
`main` branch, to avoid conflicts if you pull in updates from origin.
- Make commits of logical units.
- Check for unnecessary whitespace with `git diff --check` before committing.
- Use descriptive commit messages and reference the #issue number.

## Submitting Changes

* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/Bug_report.md

This file was deleted.

74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: 🐛 Bug report
description: Create a report to help us improve
labels: bug
assignees: jonnitto
body:
- type: markdown
attributes:
value: Thank you for taking the time to complete this bug report!
- type: markdown
attributes:
value: Please make sure to provide the information we ask for. This will allow us to help you better.
- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: A clear and concise description of the current behaviour.
placeholder: A bug happened!
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behaviour
description: A description of what you expect to happen.
placeholder: I expect to see X or Y
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Please add a link to a repository with a minimal reproduction. Or describe accurately how we can reproduce/verify the bug.
placeholder: |
Example steps (replace with your own):
1. Clone my repo at https://github.com/<myuser>/example
2. Do x and y
3. You should see the error come up
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: The version of Carbon.Notification you are using.
placeholder: ex. 2.4.0
validations:
required: true
- type: textarea
id: phpinfo
attributes:
label: PHP version
description: |
Please paste the output of running `php -v`.
This will be automatically formatted as a code block, so no need for backticks.
render: shell
validations:
required: true
- type: textarea
id: composerinfo
attributes:
label: Environment
description: |
Please paste the output of running `composer info`.
This will be automatically formatted as a code block, so no need for backticks.
render: shell
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Anything else that might be relevant
validations:
required: false
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/Feature_request.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: ✨ Feature request
description: Suggest an idea for this project
labels: enhancement
assignees: jonnitto
body:
- type: markdown
attributes:
value: Thank you for taking the time to suggest a new feature!
- type: markdown
attributes:
value: Please describe the feature in detail. Why would it would be a good addition to Carbon.Notification?
- type: textarea
id: description
attributes:
label: What should be improved?
description: Is your feature request related to a problem? Please describe it.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution you would like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Possible alternatives
description: Describe any alternatives you have considered.
validations:
required: false
- type: textarea
id: extra
attributes:
label: Additional context
description: Add any other relevant information.
validations:
required: false
- type: checkboxes
id: can-work
attributes:
label: Are you willing to work on this?
description: Are you willing to help us add this feature? If you are not sure how, feel free to ask for guidance.
options:
- label: Yes, I would like to help
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 🗣️ Ask question
url: https://github.com/CarbonPackages/Carbon.Notification/discussions/category_choices
about: Please ask and answer questions in discussions
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ Describe the big picture of your changes here to communicate to the maintainers

The best way to propose a feature is to open an issue first and discuss your ideas there before implementing them.

Always follow the [contribution guidelines](https://github.com/jonnitto/Carbon.Image/blob/master/.github/CONTRIBUTING.md) when submitting a pull request.
Always follow the [contribution guidelines](.github/CONTRIBUTING.md) when submitting a pull request.
20 changes: 20 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
changelog:
exclude:
labels:
- ignore-for-releasenotes
categories:
- title: 💥 Breaking changes
labels:
- breaking
- title: ✨ Exciting new features
labels:
- enhancement
- title: 🐛 Found and fixed bugs
labels:
- bug
- title: 📝 Added documentation
labels:
- documentation
- title: 🩹 Other changes
labels:
- '*'

0 comments on commit b01d1ab

Please sign in to comment.