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

docs: Add CONTRIBUTING and finish project setup #7

Merged
merged 10 commits into from
Jul 24, 2023
Merged

docs: Add CONTRIBUTING and finish project setup #7

merged 10 commits into from
Jul 24, 2023

Conversation

Xuanwo
Copy link
Member

@Xuanwo Xuanwo commented Jul 22, 2023 •
edited
Loading

This PR will add CONTRIBUTING guide for this project and finish the project setup works.

This PR will also close #10

@Xuanwo Xuanwo requested review from Fokko and nastra July 22, 2023 03:49
@Xuanwo
Copy link
Member Author

Xuanwo commented Jul 22, 2023 •
edited
Loading

cc @ConeyLiu & @Fokko & @nastra, would you like to take a look? Thanks.

Also cc @liurenjie1024, @JanKaul, @ZENOTME

Xuanwo
Xuanwo commented Jul 22, 2023
View reviewed changes
NOTICE Outdated Show resolved Hide resolved
@Xuanwo
Fix license
106be6f 
Signed-off-by: Xuanwo <[email protected]>
Fokko
Fokko reviewed Jul 22, 2023
View reviewed changes
NOTICE Outdated Show resolved Hide resolved
CHANGELOG.md
@@ -0,0 +1,8 @@
# Change Log
Copy link
Contributor

Choose a reason for hiding this comment

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

It is up to the individual projects, what they prefer. What I do with PyIceberg is use the GitHub milestones to keep track of what's being included in a version. You can link both issues and PRs to the milestone, and that works well for me.

Copy link
Member Author

@Xuanwo Xuanwo Jul 22, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Github ecosystem like dependabot will read changelog.md to provide more information for users, for example:
image

And I plan to utilize GitHub's built-in release note generator, which is based on pull requests, to assist us in creating the changelog. This should result in a minimal maintenance burden.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@Xuanwo
Copy link
Member Author

Xuanwo commented Jul 22, 2023

@Fokko, PTAL, thanks!

nastra
nastra reviewed Jul 22, 2023
View reviewed changes
Copy link
Contributor

@nastra nastra left a comment

Choose a reason for hiding this comment

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

Just a few small wording updates but other than that it LGTM

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@nastra nastra mentioned this pull request Jul 22, 2023
Closed
Xuanwo and others added 5 commits July 22, 2023 14:57
@Xuanwo
Merge branch 'add-license-for-md' into add-docs
8a91e20 
Signed-off-by: Xuanwo <[email protected]>
@Xuanwo
Add licenses for md
b9d86f1 
Signed-off-by: Xuanwo <[email protected]>
@Xuanwo @nastra
Update CONTRIBUTING.md
e43f2d6 
Co-authored-by: Eduard Tudenhoefner <[email protected]>
@Xuanwo
Add link to slack
a0772ec 
Signed-off-by: Xuanwo <[email protected]>
@Xuanwo
polish
b9339dd 
Signed-off-by: Xuanwo <[email protected]>
@Xuanwo
Copy link
Member Author

Xuanwo commented Jul 22, 2023

Hi, @nastra, all comments have been addressed, PTAL. Thanks!

nastra
nastra approved these changes Jul 22, 2023
View reviewed changes
Copy link
Contributor

@nastra nastra left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @Xuanwo. @Fokko do you have any other comments?

ConeyLiu
ConeyLiu approved these changes Jul 22, 2023
View reviewed changes
Copy link

@ConeyLiu ConeyLiu left a comment

Choose a reason for hiding this comment

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

Thanks for pinging me. LGTM

liurenjie1024
liurenjie1024 approved these changes Jul 24, 2023
View reviewed changes
Copy link
Contributor

@liurenjie1024 liurenjie1024 left a comment

Choose a reason for hiding this comment

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

LGTM

CONTRIBUTING.md
Copy link
Contributor

Choose a reason for hiding this comment

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

Really cool!

@Xuanwo
Copy link
Member Author

Xuanwo commented Jul 24, 2023

cc @Fokko, would you like to take another look? Thanks.

jackwener
jackwener approved these changes Jul 24, 2023
View reviewed changes
Copy link
Member

@jackwener jackwener left a comment

Choose a reason for hiding this comment

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

Cool !

ZENOTME
ZENOTME approved these changes Jul 24, 2023
View reviewed changes
Copy link
Contributor

@ZENOTME ZENOTME left a comment

Choose a reason for hiding this comment

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

LGTM!

@Fokko Fokko merged commit b875a98 into apache:main Jul 24, 2023
@Fokko
Copy link
Contributor

Fokko commented Jul 24, 2023

Thank you @Xuanwo for the PR, and @liurenjie1024, @ConeyLiu, @jackwener, @ZENOTME, and @nastra for the reviews! Great to see so many people chiming in here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ZENOTME ZENOTME ZENOTME approved these changes

@jackwener jackwener jackwener approved these changes

@ConeyLiu ConeyLiu ConeyLiu approved these changes

@liurenjie1024 liurenjie1024 liurenjie1024 approved these changes

@Fokko Fokko Fokko approved these changes

@nastra nastra nastra approved these changes

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

Successfully merging this pull request may close these issues.

Add licenses to Markdown
7 participants
@Xuanwo @Fokko @nastra @liurenjie1024 @ConeyLiu @jackwener @ZENOTME