Skip to content

Commit adc1f63

Browse files
committed
Update .github docs
# CONTRIBUTING.md - Fix relative pathing to other `.github` Markdown docs. - Update/correct request forwarding, as the Issues tracker has been disabled for the repo. # CODE_OF_CONDUCT.md - Fix a grammar nit. - `eg` should be spelled `e.g.,` as it's an acronym. - Remove a broken link to the TODO group's CoC template. - It's been updated significantly, along with the URL. Referring to it by a direct link doesn't make sense--unless using a service like `archive.org`. # ISSUE_TEMPLATE.md Remove since the Issue tracker has been disabled on the repo. # PULL_REQUEST_TEMPLATE.md Fix branding for `GitHub`. Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
1 parent 7f52b95 commit adc1f63

4 files changed

Lines changed: 25 additions & 28 deletions

File tree

.github/CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Harassment includes, but is not limited to:
1717
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, neuro(a)typicality, physical appearance, body size, race, age, regional discrimination, political or religious affiliation
1818
* Unwelcome comments regarding a person’s lifestyle choices and practices, including those related to food, health, parenting, drugs, and employment
1919
* Deliberate misgendering. This includes deadnaming or persistently using a pronoun that does not correctly reflect a person’s gender identity. You must address people by the name they give you when not addressing them by their username or handle
20-
* Physical contact and simulated physical contact (eg, textual descriptions like “hug” or “backrub”) without consent or after a request to stop
20+
* Physical contact and simulated physical contact, e.g, textual descriptions like “hug” or “backrub”, without consent or after a request to stop
2121
* Threats of violence, both physical and psychological
2222
* Incitement of violence towards any individual, including encouraging a person to commit suicide or to engage in self-harm
2323
* Deliberate intimidation
@@ -35,4 +35,4 @@ We encourage everyone to participate and are committed to building a community f
3535

3636
Although this list cannot be exhaustive, we explicitly honor diversity in age, gender, gender identity or expression, culture, ethnicity, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities.
3737

38-
_This Code Of Conduct follows the [template](http://todogroup.org/opencodeofconduct/) established by the [TODO Group](http://todogroup.org/)._
38+
_This Code Of Conduct follows an earlier version of the [TODO Group](http://todogroup.org/)'s Code of Conduct template._

.github/CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# Contributing to Blackduck Software Integration's
22

3-
If you decide to contribute to our repository, please follow our [Code of conduct](./CODE_OF_CONDUCT.md) when contributing. We value all contributions and will review them as soon as we can.
3+
If you decide to contribute to our repository, please follow our [Code of conduct](/.github/CODE_OF_CONDUCT.md) when contributing. We value all contributions and will review them as soon as we can.
44

5-
### Bugs
6-
When using our software, it is possible that you will come across a bug. If this happens, Be sure to come to our issues page to see if anyone else has ran into this same problem. If no one has reported it, then please submit an issue following this [Issue template](./ISSUE_TEMPLATE.md).
5+
## Support
76

8-
### Issues
9-
When you don't run into a bug, but have an issue or a question, then the best option is to message our [Support team](https://www.blackducksoftware.com/support/contact-support). They are available 24 hours a day and work directly with us to resolve any issues you may have.
7+
### Paid Support
8+
The best option for customers with active support contracts is to directly message our [Support team](https://www.blackducksoftware.com/support/contact-support). The support team is available 24 hours a day.
9+
10+
### Community Support
11+
Community support is available in the [BlackDuck Community portal](https://community.blackduck.com/s/). Questions (which includes, but is not limited to reporting bugs, feature requests, etc) can be directed to the [BlackDuck Community Discussions](https://community.blackduck.com/s/discussions) board.
1012

1113
## Pull Requests
12-
Anyone can directly contribute to our integrations by opening their own branch and creating a pull request. When doing so, please follow the [Pull request template](./PULL_REQUEST_TEMPLATE.md) so that we can review your request more quickly and get your code into master.
14+
Anyone can directly contribute to our integrations by opening their own branch and creating a pull request. When doing so, please follow the [Pull request template](/.github/PULL_REQUEST_TEMPLATE.md) so that we can review your request more quickly and get your code into master.
1315

1416
When creating code to be merged into our project, please adhere to the following as best you can
1517
* Create variable and method names that describe their functionality

.github/ISSUE_TEMPLATE.md

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

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
1+
<!--
2+
Delete all items in between the HTML comments (`&lt;!-- --%gt;`)
3+
-->
4+
15
# Description
26

7+
<!--
8+
39
Please include a short description of the changes and problems fixed.
410
11+
-->
12+
513
# Github Issues
614

7-
(Optional) Please link to any applicable github issues.
15+
<!--
16+
17+
(Optional)
18+
19+
Please reference any applicable GitHub issues as discussed in the [GitHub Docs](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword#linking-a-pull-request-to-an-issue-using-a-keyword).
20+
21+
-->

0 commit comments

Comments
 (0)