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

Jump to bottom

Add CONTRIBUTING.md #1591

Merged
merged 2 commits into from
Dec 5, 2023
Merged

Add CONTRIBUTING.md #1591

merged 2 commits into from
Dec 5, 2023

Conversation

OverOrion
Copy link
Contributor

No description provided.

@sagikazarmark
Copy link
Member

FYI https://github.com/kube-logging/.github/blob/main/CONTRIBUTING.md

Please don't maintain different contributing guides.

@OverOrion
Copy link
Contributor Author

OverOrion commented Nov 21, 2023 •
edited
Loading

Thanks @sagikazarmark! I did not check if it existed as the README does not link to it I (wrongly) assumed there was no such file yet. 🤦
I will merge them then.

EDIT: nevermind, it is a different repository, will link to it in the README for discoverability for sure

@pepov
Copy link
Member

pepov commented Nov 22, 2023

Can we just leave the repo specific instructions and link to the organization wide contributing guide for the general stuff?

@OverOrion OverOrion force-pushed the add-contributing-guide branch from 9d139a0 to 75b365a Compare November 28, 2023 15:34
@OverOrion
Makefile: add documentation to generate target
1b1563d 
Signed-off-by: Szilard Parrag <szilard.parrag@axoflow.com>
@OverOrion OverOrion force-pushed the add-contributing-guide branch from 75b365a to 3af430b Compare November 28, 2023 15:35
@pepov pepov requested a review from sagikazarmark December 3, 2023 18:54
@pepov
Copy link
Member

pepov commented Dec 3, 2023

@sagikazarmark the guide is now updated to focus on project related guidelines

pepov
pepov reviewed Dec 3, 2023
View reviewed changes
Copy link
Member

@pepov pepov left a comment

Choose a reason for hiding this comment

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

Something I forgot: shouldn't we mention make check as well? Also adding that using make lint-fix can fix trivial linting issues.

@OverOrion
add CONTRIBUTING.md
b126ac7 
Signed-off-by: Szilard Parrag <szilard.parrag@axoflow.com>
@OverOrion OverOrion force-pushed the add-contributing-guide branch from 3af430b to b126ac7 Compare December 4, 2023 09:07
@pepov pepov merged commit bdf0a00 into kube-logging:master Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pepov pepov pepov approved these changes

@fekete-robert fekete-robert Awaiting requested review from fekete-robert

@sagikazarmark sagikazarmark Awaiting requested review from sagikazarmark

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@OverOrion @sagikazarmark @pepov