Skip to content

Commit

Permalink
Add pull request template and small bullet points
Browse files Browse the repository at this point in the history
  • Loading branch information
seanggani committed Jun 20, 2024
1 parent 974f080 commit 376dcf1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
21 changes: 21 additions & 0 deletions pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
- [ ] Have you followed the guidelines in our [Contributor Guide](https://bcg-x-official.github.io/artkit/contributor_guide/how_to_contribute.html) document?
- [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/BCG-X-Official/artkit/pulls) for the same update/change?

<!-- You can erase any parts of this template not applicable to your Pull Request. -->

## Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change:

## Issue number and link:

## New Feature Submissions:

1. [ ] Does your submission pass tests?
2. [ ] Have you lint your code locally before submission?

## Changes to Core Features:

- [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
- [ ] Have you written new tests for your core changes, as applicable?
- [ ] Have you successfully run tests with your changes locally?
2 changes: 2 additions & 0 deletions sphinx/source/contributor_guide/how_to_contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,12 @@ Pull Request (PR) Guidelines
1. **Fork and Clone the Repository**: Start by forking the project and cloning your fork.

2. **Create a New Branch**: Work on a new branch specific to the feature or fix.
- Recommended naming convention: ``feat/<feature-name>`` or ``docs/<feature-name>``.

3. **Adhere to Commit Guidelines**: Ensure your commits follow the above guidelines.

4. **Write a Clear PR Title and Description**: When opening your PR, provide a detailed description of the changes and motivations.
- Start your PR title with a prefix: ``FEATURE``, ``FIX``, ``DOC``, ``BUILD`` etc.

5. **Keep PRs Small and Focused**: This makes PRs easier to review and merge.

Expand Down

0 comments on commit 376dcf1

Please sign in to comment.