[NO-TICKET] Create template for CONTRIBUTING.md #118
Conversation
✅ Deploy Preview for cobalt-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
| EX-NO-TICKET_reason_for_change | ||
| ``` | ||
|
|
||
| We'll include a Continuous Integration job which reviews branch names. |
There was a problem hiding this comment.
@sergey-kruk-cobalt what's a good link for SOC2 compliance? I might add:
| 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. |
|
Contributing is usually much bigger and contains a lot of specifics. Now most of it in most of the projects is in README. But eventually I think all development-related info will be in CONTRIBUTING. Do you have access to https://github.com/cobalthq/cobalt-api/blob/main/CONTRIBUTING.md ? |
I do have access. I set up this PR as a MVC (and also as a demo of how we can comply with your RFC). Rewriting the full CONTRIBUTING.md file is a larger task, and you're welcome to open a DOCS Jira for that. |
| If you're a Cobalt employee, include the group name acronym with the ticket, such as: | ||
|
|
||
| ``` | ||
| EX-NO-TICKET_reason_for_change |
There was a problem hiding this comment.
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)
| DOCS-12345_reason_for_change | ||
| ``` | ||
|
|
||
| Alternatively, if you do not have a Jira ticket, specify a branch name like |
There was a problem hiding this comment.
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 description provided.