Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NO-TICKET] Create template for CONTRIBUTING.md #118

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[NO-TICKET] Create template for CONTRIBUTING.md #118

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eca3da5
[NO-TICKET] Create template for CONTRIBUTING.md
mjang-cobalt Apr 22, 2022
e0a4940
Update CONTRIBUTING.md
mjang-cobalt Apr 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Welcome to the contributions guide for Cobalt Product Documentation

Thank you for contributing to our project! We'll build your contributions at
developer.cobalt.io.

## Branch names

If you're a Cobalt employee, please include the name of the Jira ticket in the name of the
branch. For example, if you're making changes for a ticket named DOCS-12345, specify a
branch name like:

```
DOCS-12345_reason_for_change
```

Alternatively, if you do not have a Jira ticket, specify a branch name like
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in general all branch naming rules need to reference one document (right now it't in confluence but it may move) so the basics are not repeated. And the reason to expand the section is only in case when you want to define specifics (what is the format, which PRs can have no tickets or if tickets are always required)


```
NO-TICKET_reason_for_change
```

If you're a Cobalt employee, include the group name acronym with the ticket, such as:

```
EX-NO-TICKET_reason_for_change
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think using kebab-case (at least in all documentation) would help consistency? I personally also like / dividers (which are also default for dependabot)

```

We'll include a Continuous Integration job which reviews branch names.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sergey-kruk-cobalt what's a good link for SOC2 compliance? I might add:

Suggested change
We'll include a Continuous Integration job which reviews branch names.
We'll include a Continuous Integration job which reviews branch names. This process helps us maintain [SOC2](replace_with_link_url) compliance.