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.

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

Enhance contribuiting documentation #809

Merged
merged 8 commits into from
Aug 8, 2024
Merged

Conversation

otaviojava
Copy link
Contributor

Changes

  • After seeing the first contribution of a newcomer, I could see that we are missing some guides and information for new contributions. This PR works to fix it, enhance the documentation and explain more about the legal part and the commit message using convention

Signed-off-by: Otavio Santana <[email protected]>
Signed-off-by: Otavio Santana <[email protected]>
Signed-off-by: Otavio Santana <[email protected]>
@otaviojava otaviojava requested a review from njr-11 August 2, 2024 16:44
@otaviojava
Copy link
Contributor Author

@njr-11, am I missing some information about the new contributor?

@otaviojava
Copy link
Contributor Author

@njr-11 could you review this, please?

Copy link
Contributor

@njr-11 njr-11 left a comment

Choose a reason for hiding this comment

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

Added a few grammar updates and spotted a broken link. Also, I added some suggested text to the breaking changes section to emphasize that breaking changes are discouraged.

CONTRIBUTING.adoc Outdated Show resolved Hide resolved
CONTRIBUTING.adoc Outdated Show resolved Hide resolved
CONTRIBUTING.adoc Outdated Show resolved Hide resolved
- **fix:** Any commit that patches a bug anywhere in the codebase
- **feat:** Any commit that introduces a new feature or focuses on enhancing the scope of existing features
- **breaking changes:** Any commit that has a footer "BREAKING CHANGE", or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
- **other than fix and feat:** Any commit that consists of the following keywords: `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. For other keywords refer to https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional[@commitlint/config-conventional] (based on the Angular convention)
Copy link
Contributor

Choose a reason for hiding this comment

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

This link was not working when I tried it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

otaviojava and others added 4 commits August 7, 2024 19:57
Co-authored-by: Nathan Rauh <[email protected]>
Co-authored-by: Nathan Rauh <[email protected]>
Co-authored-by: Nathan Rauh <[email protected]>
Signed-off-by: Otavio Santana <[email protected]>
@otaviojava otaviojava merged commit 5121786 into main Aug 8, 2024
4 checks passed
@otaviojava otaviojava deleted the enhance-contribuiting branch August 8, 2024 03:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants