Skip to content

Commit 5e25a75

Browse files
committed
Minor docs update.
1 parent 09553eb commit 5e25a75

File tree

4 files changed

+504
-43
lines changed

4 files changed

+504
-43
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
## **Did you find a bug?**
44

5-
* Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/xBimTeam/XbimEssentials/issues).
5+
* Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/xBimTeam/XbimEssentials/issues).
66

7-
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/xBimTeam/XbimEssentials/issues/new).
8-
Be sure to include a **title and clear description**, as much relevant information as possible; if useful an IFC file should be attached to
7+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/xBimTeam/XbimEssentials/issues/new).
8+
Be sure to include a **title and clear description**, as much relevant information as possible; if useful an IFC file should be attached to
99
the issue and a **code sample** demonstrating the fault. xBIM can be used to extract parts of IFC file to isolate the problem if it is data-related.
1010

1111
* The Xbim toolkit is composed of a collection of projects, please ensure that you post your issue under the relevant project.
1212

1313
## **Did you write a patch that fixes a bug?**
1414

15-
* Open a new [GitHub pull](https://help.github.com/articles/about-pull-requests/) request with the patch.
15+
* Open a new [GitHub pull request](https://help.github.com/articles/about-pull-requests/) with the patch.
1616

17-
* we have two branches in the project, please work on the development branch; your contribution will be merged there and then to master upon the next release.
17+
* we have two branches in the project, **please work on the development branch**; your contribution will be merged there and then to master upon the next release.
1818

19-
* Ensure the PR description clearly describes the problem and solution. Include a relevant issue number if applicable.
19+
* Ensure the PR description clearly captures the problem and solution. Include a relevant issue number, if applicable.
2020

2121
## **Did you fix whitespace, format code, or make a purely cosmetic patch?**
2222

@@ -32,6 +32,6 @@ We are still likely to accept your PR in this case, patches that improve the doc
3232

3333
Xbim is a volunteer effort. We encourage you to pitch in!
3434

35-
Thanks!
35+
Thanks!
3636

3737
The Xbim Team

0 commit comments

Comments
 (0)