docs: add contributing guide - #16
Merged
Merged
Conversation
ricardokojo
force-pushed
the
docs/add-contributing-guide
branch
from
June 10, 2026 03:46
fd505fe to
73fa5a7
Compare
EllianCarlos
approved these changes
Jun 10, 2026
| @@ -0,0 +1,105 @@ | |||
| # Contributing Guide | |||
|
|
|||
| Thanks for contributing to `cregit`! | |||
Collaborator
There was a problem hiding this comment.
Maybe add cregit-codev and also mention the original one for now. Or do you think that should be in the README?
| - new dependencies | ||
| - changes to output formats, CLI behavior, or generated artifacts | ||
|
|
||
| ## Commit messages |
Collaborator
There was a problem hiding this comment.
I feel like just adding the conventional commits with do's vs don't's ?
|
|
||
| ## Documentation | ||
|
|
||
| If your change affects behavior, commands, configuration, outputs, or developer workflow, _update the relevant documentation_. |
Collaborator
There was a problem hiding this comment.
If we don't have docs are we okay with keeping without docs?
This was referenced Jun 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Create
CONTRIBUTING.md.Closes #10