Skip to content

Commit a2db978

Browse files
authored
Update CONTRIBUTING.md
1 parent dbf8cae commit a2db978

File tree

1 file changed

+2
-19
lines changed

1 file changed

+2
-19
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,9 @@ We use issues to track work items, such as bug reports and feature requests. Iss
7676

7777
Our issue tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:
7878

79-
- `bug` - A bug is a _demonstrable problem_ that is caused by the code in the repository. Please check if the issue has already been reported before reporting a new bug.
80-
- `DevX` - Suggest an enhancement to the developer experience (DX). DX enhancements improve experience for those building UIs with PatternFly, but have little to know end user impact.
81-
- `Feature` - Suggest a new feature for PatternFly. Features augment or impact end user experience and requires design input.
8279
- `breaking change` - this issue warrants a major release and potentially changes APIs for downstream consumers.
83-
- `Tech debt` - Improvements to code that do not affect either user or product developers’ experiences.
84-
- `documentation` - this issue affects documentation only.
85-
- `css` - this issue affects CSS or has stylistic changes.
8680
- `good first issue` - Issues that are ideal for new contributors.
8781
- `wontfix` - The issue is legitimate, but it is not something the team is currently able or willing to fix or implement. Issues with this label may be revisited in the future.
88-
- `p1`, `p2`, `p3` - These are priority labels.
8982

9083
### PR labels
9184

@@ -96,17 +89,9 @@ Since the components in patternfly-react are based on patternfly, we want to mak
9689
- `css approved` - The issue has been reviewed and approved by a member of the css team.
9790
- `ux approved` - The issue has been reviewed and approved by a member of the ux team.
9891

99-
### Project board columns
92+
### Integration with Jira
10093

101-
The project board uses the following columns to track issues:
102-
103-
- `Backlog` - Issues that are ready to be worked and available for any contributor to take.
104-
- `Needs info` - Issues that require any work that would be completed outside of this repo related to css, design or research. For example some component contributions will require updates to css in the core [patternfly](https://github.com/patternfly/patternfly) repo.
105-
- `Not started` - Issues that are ready to be worked and are already assigned.
106-
- `In Progress` - Issues that are actively being worked.
107-
- `PR in Review` - Issues for which a PR is open and are ready for review.
108-
109-
Issues can be manually added to the project board from either the issue page or the project board page.
94+
We sync our issues to PatternFly's private Jira board. Once an issue is sync'd, a link is added to the issue description in GitHub if someone were to want to track the Jira ticket. Any issue can be assigned an assignee in GitHub or Jira and that information will be sync'd. If an issue is closed in Jira, it will also be closed in GitHub.
11095

11196
## Contribution process
11297

@@ -118,15 +103,13 @@ If you find a bug within the repo, please help us track the issue by following t
118103
- If it does exist, but doesn’t capture key details that you have noticed, please add a comment to the existing bug.
119104
2. Create an issue if one doesn’t already exist.
120105
- Provide details like what component is affected, steps to reproduce, and any other information that is critical to addressing the issue
121-
- Assign the label “bug” to the issue
122106

123107
### Creating issues for new components
124108

125109
To create an issue for adding a new component to the repo, please observe the following process:
126110

127111
1. If the component does not yet exist as a PatternFly component, please do not start coding yet. Components contributed to PatternFly-React should have a design pattern in PatternFly or be approved PatternFly-Extension components.
128112
2. If the component exists in PatternFly core (meaning CSS and the pattern design exists), then create an issue with the following details:
129-
- Assign the label `enhancement` to the issue
130113
- Include the text “Component -“ in the beginning of the title if the issue captures a new component
131114
- If the component is documented as a [PatternFly library pattern](http://www.patternfly.org/pattern-library/), include a link to it.
132115
3. If a component is not in PatternFly, but you feel it would be a good addition to the library, please do the following:

0 commit comments

Comments
 (0)