Skip to content

Commit a419e70

Browse files
committed
add specific line items to contributing doc for issues, update branch list
1 parent c92a759 commit a419e70

File tree

1 file changed

+39
-9
lines changed

1 file changed

+39
-9
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,65 @@
11
# Contributing to Bootstrap
22

3-
Recommendations and requirements for how to best contribute to Bootstrap. We strive to obey these as best as possible, though we may drift as development continues in our primary development branches. As always, thanks for contributing--we hope these guidelines make it easier and shed some light on our approach and processes.
3+
Looking to contribute something to Bootstrap? **Here's how you can help.**
44

5-
### Key branches
6-
- `master` is the latest, deployed version
7-
- `*-wip` is the official work in progress branch for the next release
85

9-
### Notes on the repo
6+
7+
## Reporting issues
8+
9+
We only accept issues that are bug reports or feature requests. Bugs must be isolated and reproducible problems that we can fix within the Bootstrap core. Please read the following guidelines before opening any issue.
10+
11+
1. **Search for existing issues.** We get a lot of duplicate issues, and you'd help us out a lot by first checking if someone else has reported the same issue. Moreover, the issue may have already been resolved with a fix available.
12+
2. **Create an isolated and reproducible test case.** Be sure the problem exists in Bootstrap's code with a [reduced test cases](http://css-tricks.com/reduced-test-cases/) that should be included in each bug report.
13+
3. **Include a live example.** Make use of jsFiddle or jsBin to share your isolated test cases.
14+
4. **Share as much information as possible.** Include operating system and version, browser and version, version of Bootstrap, customized or vanilla build, etc. where appropriate. Also include steps to reproduce the bug.
15+
16+
17+
18+
## Key branches
19+
20+
- `master` is the latest, deployed version.
21+
- `gh-pages` is the hosted docs (not to be used for pull requests).
22+
- `*-wip` is the official work in progress branch for the next release.
23+
24+
25+
26+
## Notes on the repo
27+
1028
As of v2.0.0, Bootstrap's documentation is powered by Mustache templates and built via `make` before each commit and release. This was done to enable internationalization (translation) in a future release by uploading our strings to the [Twitter Translation Center](http://translate.twttr.com/). Any edits to the docs should be first done in the Mustache files and then recompiled into the HTML.
1129

12-
### Pull requests
30+
31+
32+
## Pull requests
33+
1334
- Try to submit pull requests against the latest `*-wip` branch for easier merging
1435
- Any changes to the docs must be made to the Mustache templates, not just the compiled HTML pages
1536
- CSS changes must be done in .less files first, never just the compiled files
1637
- If modifying the .less files, always recompile and commit the compiled files bootstrap.css and bootstrap.min.css
1738
- Try not to pollute your pull request with unintended changes--keep them simple and small
1839
- Try to share which browsers your code has been tested in before submitting a pull request
1940

20-
### Coding standards: HTML
41+
42+
43+
## Coding standards: HTML
44+
2145
- Two spaces for indentation, never tabs
2246
- Double quotes only, never single quotes
2347
- Always use proper indentation
2448
- Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags)
2549

26-
### Coding standards: CSS
50+
51+
52+
## Coding standards: CSS
53+
2754
- Adhere to the [Recess CSS property order](http://markdotto.com/2011/11/29/css-property-order/)
2855
- Multiple-line approach (one property and value per line)
2956
- Always a space after a property's colon (.e.g, `display: block;` and not `display:block;`)
3057
- End all lines with a semi-colon
3158
- For multiple, comma-separated selectors, place each selector on it's own line
3259
- Attribute selectors, like `input[type="text"]` should always wrap the attribute's value in double quotes, for consistency and safety (see this [blog post on unquoted attribute values](http://mathiasbynens.be/notes/unquoted-attribute-values) that can lead to XSS attacks).
3360

34-
### License
61+
62+
63+
## License
64+
3565
By contributing your code, you agree to license your contribution under the terms of the APLv2: https://github.com/twitter/bootstrap/blob/master/LICENSE

0 commit comments

Comments
 (0)