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

Docs(repo): Edit contributing guide #41

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dlouhak
Copy link
Contributor

@dlouhak dlouhak commented Mar 7, 2023

No description provided.

@dlouhak dlouhak added the documentation Improvements or additions to documentation label Mar 7, 2023
@dlouhak dlouhak self-assigned this Mar 7, 2023
@dlouhak dlouhak requested a review from a team as a code owner March 7, 2023 09:56
Copy link
Contributor

@adamkudrna adamkudrna left a comment

Choose a reason for hiding this comment

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

Grammarly suggests there could be some improvents… 🙂

obrazek

Comment on lines +27 to 32
1. Please, manually edit commit message according [commit guidelines](#commit-messages) to ensure proper version and changelog
1. Merge all appropriate PRs you want to publish into `main` branch
1. Checkout to the `main` branch and run the `make version` command to bump the version number in packages (new version number is determined automatically based on commit history)
1. Check that the version number is correct and everything looks good
1. Run manually `git push && git push --tags` to push the changes to remote
1. Publishing is done automatically by GitHub Actions (uses `build` script and `make publish` command)
Copy link
Contributor

Choose a reason for hiding this comment

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

Having 1 everywhere is easier to edit, but harder to read… It's up to you to decide what matters more 🙂.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants