BLogic Systems

Pull Request Template

Last updated on 

Setup

  1. Create a new file: In your GitHub repository, navigate to the .github directory (create one if it doesn’t exist). Inside this directory, create a new file named PULL_REQUEST_TEMPLATE.md. The .md extension indicates that it’s a Markdown file.
  2. Add template content: Open the PULL_REQUEST_TEMPLATE.md file in a text editor and add the template content. This content can include instructions, guidelines, and sections for contributors to fill out. For example:
## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

- [ ] 🐛 Bugfix
- [ ] ✨ Feature
- [ ] 🎨 Code style update (formatting, local variables)
- [ ] ♻️ Refactoring (no functional changes, no api changes)
- [ ] 👷 Build related changes
- [ ] 💚 CI related changes
- [ ] 📝 Documentation content changes
- [ ] Other... Please describe:

## PR Checklist

Please check if your PR fulfills the following requirements:

<!-- Please check the one that applies to this PR using "x". -->

- [ ] 🚨 The commit message follows our guidelines: https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines
- [ ] 📐 The code has been formatted with Prettier
- [ ] 🧪 Tests for the changes have been added (for bug fixes / features)
- [ ] 📝 Docs have been added / updated (for bug fixes / features)

## What is the current behavior?

<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->

Issue Number: N/A

## What is the new behavior?

## Does this PR introduce a breaking change?

<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->

- [ ] Yes
- [ ] No

## Other information
  1. Save and commit: Save the changes to the PULL_REQUEST_TEMPLATE.md file and commit it to your repository.
  2. Test the template: Create a new pull request in your repository, and you should see your template automatically loaded in the pull request description. Contributors will need to fill out the checklist and provide the requested information.
By using a pull request template, you can standardize the information provided in pull requests, making it easier for you and your team to review and merge contributions.