Skip to content

Commit 7284520

Browse files
committed
chore: add issue templates, code of conduct & contributing guidelines
1 parent efa7d25 commit 7284520

File tree

9 files changed

+375
-0
lines changed

9 files changed

+375
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Carbon Code of Conduct
2+
3+
This is a place to ask questions, work through any challenges, and share ideas and best practices. The following suggestions and guidelines are intended to make the community easier and more enjoyable to use.
4+
5+
### TLDR;
6+
7+
- **Be respectful & understanding.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior or poor manners. It is important that we resolve disagreements and differing views constructively.
8+
9+
* **Be welcoming.** We strive to be a community that welcomes and supports people of all backgrounds and identities.
10+
11+
### General
12+
13+
Communication through any of Carbon's channels (GitHub, emails, Twitter, Slack) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
14+
15+
We promise to extend courtesy and respect to everyone involved in this project, regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to Carbon to do the same.
16+
17+
If any member of the community violates this Code of Conduct, the maintainers of Carbon may take action, including removing issues, comments, and PRs or blocking accounts, as deemed appropriate.
18+
19+
If you are subjected to or witness unacceptable behavior, or have any other concerns, please communicate with us directly via carbon@us.ibm.com.
20+
21+
### Slack
22+
23+
1. Please, no `@here` or `@channel` unless it is a bug that is **breaking production code.** We have communities in many different time zones, and we would hate to disrupt someone not at the office.
24+
2. There's no need to notify the Carbon team that you have made an issue in Carbon's GitHub repositories. We check these several times a day, so we promise we'll address your issue as soon as we can.
25+
3. Reserve direct messages for sensitive discussions, such as privacy, legal, or HR reasons. Otherwise, we encourage posting in public channels so people with the same questions can benefit.
26+
4. If you have a pressing bug fix, it is best to make a PR directly to get your issues addressed.
27+
5. `#carbon-components`: This channel is for questions about Carbon Components only. It is not the place to ask general coding questions. Instead, use a dev community like [StackOverflow](https://stackoverflow.com/).
28+
6. `#carbon-design-system`: Please post any design questions with an in-context screen shot (i.e. screen shot of the whole UI you are designing) with background as to what you are trying to accomplish in this flow. We welcome in-progress work to get community design feedback as well.
29+
30+
<hr>
31+
32+
If you have suggestions to improve this Code of Conduct, please submit an issue or PR.
33+
34+
This Code of Conduct was adopted from the [Angular Project](https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md) and [Todo Open Code of Conduct](http://todogroup.org/opencodeofconduct/).

.github/CONTRIBUTING.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Contribution Guidelines
2+
3+
Want to contribute to this repository? Please read below first:
4+
5+
- [Issues and Bugs](#issues-and-bugs)
6+
- [Feature Requests](#feature-requests)
7+
- [Doc Fixes](#doc-fixes)
8+
- [Submission Guidelines](#submission-guidelines)
9+
10+
## Issues and Bugs
11+
12+
If you find a bug in the source code or a mistake in the documentation, you can help us by
13+
submitting an issue to this repo. Even better you can submit a Pull Request with a fix.
14+
15+
**Please see the Submission Guidelines below**.
16+
17+
## Feature Requests
18+
19+
You can request a new feature by submitting an issue to this repo. Proposed features (with suitable design documentation and reasoning) can be crafted and submitted to this repo as a Pull Request.
20+
21+
**Please see the Submission Guidelines below**.
22+
23+
## Doc Fixes
24+
25+
If you want to help improve the docs, it's a good idea to let others know what you're working on to minimize duplication of effort. Comment on an issue to let others know what you're working on, or create a new issue if your work doesn't fit within the scope of any of the existing doc fix projects.
26+
27+
**Please see the Submission Guidelines below**.
28+
29+
## Submission Guidelines
30+
31+
### Setup
32+
33+
1. Fork the project by navigating to the main [repository](https://github.com/carbon-design-system/carbon-website) and clicking the **Fork** button on the top-right corner.
34+
35+
2. Navigate to your forked repository and copy the **SSH url**. Clone your fork by running the following in your terminal:
36+
37+
```
38+
$ git clone git@github.com:{ YOUR_USERNAME }/design-language-website.git
39+
$ cd design-language-website
40+
```
41+
42+
See [GitHub docs](https://help.github.com/articles/fork-a-repo/) for more details on forking a repository.
43+
44+
3. Once cloned, you will see `origin` as your default remote, pointing to your personal forked repository. Add a remote named `upstream` pointing to the main `design-language-website`:
45+
46+
```
47+
$ git remote add upstream git@github.com:carbon-design-system/design-language-website.git
48+
$ git remote -v
49+
```
50+
51+
Your terminal should output something like this:
52+
53+
```
54+
origin [your forked repo] (fetch)
55+
origin [your forked repo] (push)
56+
upstream git@github.com/carbon-design-system/carbon-website.git (fetch)
57+
upstream git@github.com/carbon-design-system/carbon-website.git (push)
58+
```
59+
60+
### Submitting an Issue
61+
62+
Before you submit your issue, search the repository. Maybe your question was already answered.
63+
64+
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.
65+
66+
### Submitting a Pull Request
67+
68+
1. Search this repository for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
69+
70+
2. Pull the latest master branch from `upstream`:
71+
72+
```
73+
$ git pull upstream master
74+
```
75+
76+
3. Always work and submit pull requests from a branch. _Do not submit pull requests from the `master` branch of your fork_.
77+
78+
```
79+
$ git checkout -b { YOUR_BRANCH_NAME } master
80+
```
81+
82+
4. Create your patch or feature following our [development guidelines](/README.md#development). Make sure to also follow our [coding standards](#coding-standards).
83+
84+
5. Test your branch and add new test cases where appropriate per the [testing guidelines](#testing).
85+
86+
6. Commit your changes using a descriptive commit message.
87+
88+
```
89+
$ git commit -a -m "chore: Update header with newest designs, resolves #123"
90+
```
91+
92+
**Note:** the optional commit -a command line option will automatically "add" and "rm" edited files. See [Close a commit via commit message](https://help.github.com/articles/closing-issues-via-commit-messages/) and [writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages) for more details on commit messages.
93+
94+
7. Once ready for feedback from other contributors and maintainers, **push your commits to your fork** (be sure to run `yarn ci-check` before pushing, to make sure your code passes linting and unit tests):
95+
96+
```
97+
$ git push origin { YOUR_BRANCH_NAME }
98+
```
99+
100+
8. In GitHub, navigate to [carbon-design-system/design-language-website](https://github.com/carbon-design-system/carbon-website) and click the button that reads "Compare & pull request".
101+
102+
9. Write a title and description, the click "Create pull request".
103+
104+
See [how to write the perfect pull request](https://github.com/blog/1943-how-to-write-the-perfect-pull-request) for more details on writing good PRs.
105+
106+
10. Stay up to date with the activity in your pull request. Maintainers will be reviewing your work and making comments, asking questions and suggesting changes to be made before they merge your code. When you need to make a change, add, commit and push to your branch normally.
107+
108+
Once all revisions to your pull request are complete, a maintainer will squash and merge your commits for you.
109+
110+
**That's it! Thank you for your contribution!**

.github/ISSUE_TEMPLATE.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!-- Feel free to remove sections that aren't relevant.
2+
3+
## Title line template: [Title]: Brief description
4+
5+
-->
6+
7+
## Detailed description
8+
9+
> Describe in detail the issue you're having.
10+
11+
> Is this a feature request (new component, new icon), a bug, or a general issue?
12+
13+
> What did you expect to happen? What happened instead? What would you like to see changed?
14+
15+
> What browser are you working in?
16+
17+
> What offering/product do you work on? Any pressing ship or release dates we should be aware of?
18+
19+
## Steps to reproduce the issue
20+
21+
<!--
22+
Please try to re-create the issue using our Codesandbox template available here:
23+
- React https://codesandbox.io/s/x2mjypo6pp - Vue https://codesandbox.io/s/5zk452o9jp
24+
25+
This helps reduce the issue to an isolated case that helps us out when debugging.
26+
If you're able to reproduce using the codesandbox link above, please include the
27+
link in addition to the steps to reproduce. Thanks so much!
28+
-->
29+
30+
<!-- [Codesandbox](<url>) -->
31+
32+
1. Step one
33+
2. Step two
34+
3. Step three
35+
4. etc.
36+
37+
## Additional information
38+
39+
- Screenshots or code
40+
- Notes
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Accessibility Issue ♿
3+
about: Report an accessibility or usability issue
4+
title: ''
5+
labels: 'type: a11y'
6+
assignees: ''
7+
---
8+
9+
<!-- Feel free to remove sections that aren't relevant.
10+
11+
## Title line template: [Title]: Brief description
12+
13+
-->
14+
15+
## Environment
16+
17+
> Operating system
18+
19+
> Browser
20+
21+
> Automated testing tool and ruleset
22+
23+
> Assistive technology used to verify
24+
25+
## Detailed description
26+
27+
> What version of the Carbon Design System are you using?
28+
29+
> What did you expect to happen?
30+
31+
> What happened instead?
32+
33+
> What WCAG 2.1 checkpoint does the issue violate?
34+
35+
## Steps to reproduce the issue
36+
37+
1. Step one
38+
2. Step two
39+
3. Step three
40+
4. etc.
41+
42+
> Please create a reduced test case in CodeSandbox
43+
> https://codesandbox.io/s/github/IBM/carbon-components-react/tree/master/examples/codesandbox
44+
45+
## Additional information
46+
47+
- Screenshots or code
48+
- Notes
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: "Bug Report \U0001F41B"
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!-- Feel free to remove sections that aren't relevant.
10+
11+
## Title line template: [Title]: Brief description
12+
13+
-->
14+
15+
## Detailed description
16+
17+
> Describe in detail the issue you're having.
18+
19+
> What did you expect to happen? What happened instead? What would you like to see changed?
20+
21+
> What browser are you working in?
22+
23+
## Steps to reproduce the issue
24+
25+
1. Step one
26+
2. Step two
27+
3. Step three
28+
4. etc.
29+
30+
## Additional information
31+
32+
- Screenshots or code
33+
- Notes
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: "Feature request \U0001F4A1"
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
Use this template if you want to request a new feature, or a change to an existing feature.
10+
11+
If you are reporting a bug or problem, please use the bug template instead.
12+
13+
### Summary
14+
15+
Please describe your request in one or two sentences.
16+
17+
Clarify if you are asking for both design and development, or just design, or just development.
18+
19+
### Justification
20+
21+
Provide the business reasons for this request.
22+
23+
### Desired UX and success metrics
24+
25+
Describe the full user experience for this feature. Also define the metrics by which we can measure success/failure for the user.
26+
27+
### "Must have" functionality
28+
29+
Highlight any "must have" needs and functionality for the request.
30+
31+
This should not be a full list of functionality; the Carbon team will work with you to define functionality based on the desired UX.
32+
33+
### Specific timeline issues / requests
34+
35+
Do you want this work within a specific time period? Is it related to an upcoming release?
36+
37+
_NB: The Carbon team will try to work with your timeline, but it's not guaranteed. The earlier you make a request in advance of a desired delivery date, the better!_
38+
39+
### Available extra resources
40+
41+
What resources do you have to assist this effort?
42+
43+
_Carbon is a collaborative system. We encourage teams to build components and submit them for integration as either add-ons or core components._

.github/ISSUE_TEMPLATE/feedback.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Website Feedback
3+
about: User feedback collected from the IBM Design Language Website.
4+
labels: feedback
5+
assignees: ''
6+
---
7+
8+
<!--
9+
10+
Thanks in advance for your feedback on the Carbon website!
11+
12+
13+
-->
14+
15+
## Summary
16+
17+
## Relevant information
18+
19+
<!-- Provide as much useful information as you can -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Question ❓
3+
about: Usage question or discussion about the IBM Design Language Website.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!--
10+
11+
Hi there! 👋 Hope everything is going okay using projects from the Carbon Design
12+
System. It looks like you might have a question about our work, so we wanted to
13+
share a couple resources that you could use if you haven't tried them yet 🙂.
14+
15+
If you're an IBMer, we have a couple of Slack channels available across all IBM
16+
Workspaces:
17+
18+
- #carbon-design-system for questions about the Design System
19+
- #carbon-components for questions about component styles
20+
- #carbon-react for questions about our React components
21+
22+
If these resources don't work out, help us out by filling out a couple of
23+
details below!
24+
25+
-->
26+
27+
## Summary
28+
29+
## Relevant information
30+
31+
<!-- Provide as much useful information as you can -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Closes #
2+
3+
{{short description}}
4+
5+
#### Changelog
6+
7+
**New**
8+
9+
- {{new thing}}
10+
11+
**Changed**
12+
13+
- {{change thing}}
14+
15+
**Removed**
16+
17+
- {{removed thing}}

0 commit comments

Comments
 (0)