Skip to content

Commit b4d3b63

Browse files
committed
add better templates/info files
1 parent ed5372c commit b4d3b63

File tree

10 files changed

+451
-37
lines changed

10 files changed

+451
-37
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 [email protected].
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: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
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+
* [Coding Standards](#coding-standards)
10+
* [Commit Message Guidelines](#commit-message-guidlines)
11+
* [Testing](#testing)
12+
13+
## Issues and Bugs
14+
15+
If you find a bug in the source code or a mistake in the documentation, you can help us by
16+
submitting an issue to this repo. Even better you can submit a Pull Request with a fix.
17+
18+
**Please see the Submission Guidelines below**.
19+
20+
## Feature Requests
21+
22+
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.
23+
24+
**Please see the Submission Guidelines below**.
25+
26+
## Doc Fixes
27+
28+
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.
29+
30+
**Please see the Submission Guidelines below**.
31+
32+
## Submission Guidelines
33+
34+
### Setup
35+
36+
1. Fork the project by navigating to the main [repository](https://github.com/IBM/carbon-components-angular) and clicking the **Fork** button on the top-right corner.
37+
38+
2. Navigate to your forked repository and copy the **SSH url**. Clone your fork by running the following in your terminal:
39+
40+
```
41+
$ git clone [email protected]:{ YOUR_USERNAME }/carbon-components-angular.git
42+
$ cd carbon-components-angular
43+
```
44+
45+
See [GitHub docs](https://help.github.com/articles/fork-a-repo/) for more details on forking a repository.
46+
47+
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 `carbon-components-angular`:
48+
49+
```
50+
$ git remote add upstream [email protected]:IBM/carbon-components-angular.git
51+
$ git remote -v
52+
```
53+
54+
### Submitting an Issue
55+
56+
Before you submit your issue, search the repository. Maybe your question was already answered.
57+
58+
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.
59+
60+
### Submitting a Pull Request
61+
62+
1. Search this repository for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
63+
64+
2. Pull the latest master branch from `upstream`:
65+
66+
```
67+
$ git pull upstream master
68+
```
69+
70+
3. Always work and submit pull requests from a branch. _Do not submit pull requests from the `master` branch of your fork_.
71+
72+
```
73+
$ git checkout -b { YOUR_BRANCH_NAME } master
74+
```
75+
76+
4. Create your patch or feature following our [development guidelines](/README.md#development). Make sure to also follow our [coding standards](#coding-standards).
77+
78+
5. Test your branch and add new test cases where appropriate per the [testing guidelines](#testing).
79+
80+
6. Commit your changes using a descriptive commit message.
81+
82+
```
83+
$ git commit -a -m "chore: Update header with newest designs, resolves #123"
84+
```
85+
86+
**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.
87+
88+
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):
89+
90+
```
91+
$ git push origin { YOUR_BRANCH_NAME }
92+
```
93+
94+
8. In Github, navigate to [IBM/carbon-components-react](https://github.com/IBM/carbon-components-react) and click the button that reads "Compare & pull request".
95+
96+
9. Write a title and description, the click "Create pull request".
97+
98+
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.
99+
100+
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.
101+
102+
Once all revisions to your pull request are complete, a maintainer will squash and merge your commits for you.
103+
104+
**That's it! Thank you for your contribution!**
105+
106+
## Coding Standards
107+
108+
To ensure consistency throughout the source code, keep these rules in mind as you are working:
109+
110+
### Style Guide
111+
112+
For a set of basic rules and guidelines for developing React components, see [here](https://github.com/airbnb/javascript/tree/master/react#basic-rules).
113+
114+
Feel free to edit/write components in your own style but be wary that we may ask you to make changes while reviewing your pull request.
115+
116+
### Linting
117+
118+
We enforce some style rules for code in this repository using [eslint](http://eslint.org/). You can install a linting addon to a lot of editors and IDEs that will follow our linting rules.
119+
120+
If you decide to not install a linter addon, or cannot, you can run `yarn lint` to get a report of any style issues. Any issues not fixed will be caught during CI, and will prevent merging.
121+
122+
## Commit Message Guidelines
123+
124+
We use commit message guidelines based on the [Angular Commit Conventions](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit).
125+
126+
After the commit message has been submitted, it is checked by [`husky`](https://www.npmjs.com/package/husky) and [`validate-commit-msg`](https://www.npmjs.com/package/validate-commit-msg) to ensure it is syntactically correct.
127+
128+
## Testing
129+
130+
If you add any features to our code, make sure to add tests so that your changes are covered. Tests are written using Jasmine and Karma.
131+
132+
Test your changes by running our test commands:
133+
134+
* Run linting:
135+
136+
```
137+
npm run lint
138+
```
139+
140+
* Run unit tests:
141+
142+
```
143+
npm run test
144+
```
145+
146+
* Watching unit tests:
147+
148+
```
149+
npm run test:watch
150+
```

.github/ISSUE_TEMPLATE.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
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+
> Is this issue related to a specific component?
14+
15+
> What did you expect to happen? What happened instead? What would you like to see changed?
16+
17+
> What browser are you working in?
18+
19+
> What version of the Carbon Design System are you using?
20+
21+
> What offering/product do you work on? Any pressing ship or release dates we should be aware of?
22+
23+
## Steps to reproduce the issue
24+
25+
<!--
26+
Please try to re-create the issue using our Codesandbox template available here:
27+
https://codesandbox.io/s/x2mjypo6pp
28+
29+
This helps reduce the issue to an isolated case that helps us out when debugging.
30+
If you're able to reproduce using the codesandbox link above, please include the
31+
link in addition to the steps to reproduce. Thanks so much!
32+
-->
33+
34+
<!-- [Codesandbox](<url>) -->
35+
36+
1. Step one
37+
2. Step two
38+
3. Step three
39+
4. etc.
40+
41+
## Additional information
42+
43+
* Screenshots or code
44+
* Notes

.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 IBM/carbon-components-angular#
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}}

.github/SUPPORT.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Support
2+
3+
If you run into an issue, sorry about that! We definitely want to make sure that
4+
your experience using the Carbon Design System is the best that it can be.
5+
6+
When this happens, just create an issue on GitHub by filling out the template
7+
and we'll try our best to respond in a reasonable time.

CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

ISSUE_TEMPLATE.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)