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

doc: update contributing guide #25

Merged
merged 19 commits into from
Apr 20, 2024
Merged

Conversation

yizha1
Copy link
Contributor

@yizha1 yizha1 commented Apr 23, 2023

Resolve #6

Signed-off-by: Yi Zha yizha1@microsoft.com

Signed-off-by: Yi Zha <yizha1@microsoft.com>
Signed-off-by: Yi Zha <yizha1@microsoft.com>
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Yi Zha <yizha1@microsoft.com>
@yizha1 yizha1 requested a review from shizhMSFT April 27, 2023 06:17
shizhMSFT
shizhMSFT previously approved these changes Apr 27, 2023
Copy link

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

@Sumitmaithani
Copy link

I noticed that the instructions for committing and pushing changes don't include the signoff command, also known as DCO. I think it would be great to add this information to the instructions.

Currently:

git add <files_changed>
git commit -m <commit_message>
git push origin HEAD

Expected:

git add <files_changed>
git commit -s -m <commit_message>
git push origin HEAD

Signed-off-by: Yi Zha <yizha1@microsoft.com>
@yizha1
Copy link
Contributor Author

yizha1 commented May 12, 2023

I noticed that the instructions for committing and pushing changes don't include the signoff command, also known as DCO. I think it would be great to add this information to the instructions.

Thanks @Sumitmaithani , Please check this section to see whether it solves your problem.

@Sumitmaithani
Copy link

@yizha1 👍 Looks great!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

PTAL

CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Yi Zha <yizha1@microsoft.com>
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM for using it as the first version

FeynmanZhou
FeynmanZhou previously approved these changes Nov 10, 2023
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM

priteshbandi
priteshbandi previously approved these changes Nov 22, 2023
Copy link

@priteshbandi priteshbandi 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 Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@yizha1
Copy link
Contributor Author

yizha1 commented Dec 21, 2023

Thanks for all the comments. I will resolve them before end of 12/22/2023.

Signed-off-by: Yi Zha <yizha1@microsoft.com>
@yizha1 yizha1 dismissed stale reviews from priteshbandi and FeynmanZhou via bf7834d December 27, 2023 06:15
priteshbandi pushed a commit to notaryproject/notation-go that referenced this pull request Mar 18, 2024
This PR enables the `notation-go` repo to run stale action at 1:30 every
day to label or close stale PRs and issues. See guideline
https://github.com/marketplace/actions/close-stale-issues

This is the definition for stale PRs or issues that we discussed during
community call and to be updated in [contributing
PR](notaryproject/.github#25).

"A stale issue is one that remains inactive or without updates for a
period of 60 days. A stale pull request (PR) is one that remains
inactive or without updates for a period of 45 days. When an issue or PR
becomes stale, it is labelled as `stale`. Normally maintainers will
comment on stale issues or PRs to prompt participants to take action. If
there is no activity for additional 30 days, this issue or PR will be
closed. If an update/comment occur on stale issues or pull requests, the
stale label will be removed, and the timer will restart"

Signed-off-by: Yi Zha <yizha1@microsoft.com>
yizha1 added a commit to notaryproject/notation that referenced this pull request Mar 21, 2024
This PR enables the `notation` repo to run stale action at 1:30 every
day to label or close stale PRs and issues. See guideline
https://github.com/marketplace/actions/close-stale-issues

This is the definition for stale PRs or issues that we discussed during
community call and to be updated in [contributing
PR](notaryproject/.github#25).

"A stale issue is one that remains inactive or without updates for a
period of 60 days. A stale pull request (PR) is one that remains
inactive or without updates for a period of 45 days. When an issue or PR
becomes stale, it is labelled as `stale`. Normally maintainers will
comment on stale issues or PRs to prompt participants to take action. If
there is no activity for additional 30 days, this issue or PR will be
closed. If an update/comment occur on stale issues or pull requests, the
stale label will be removed, and the timer will restart"

Signed-off-by: Yi Zha <yizha1@microsoft.com>

---------

Signed-off-by: Yi Zha <yizha1@microsoft.com>
yizha1 added a commit to notaryproject/notation-core-go that referenced this pull request Mar 21, 2024
This PR enables the `notation-core-go` repo to run stale action at 1:30
every day to label or close stale PRs and issues. See guideline
https://github.com/marketplace/actions/close-stale-issues

This is the definition for stale PRs or issues that we discussed during
community call and to be updated in [contributing
PR](notaryproject/.github#25).

"A stale issue is one that remains inactive or without updates for a
period of 60 days. A stale pull request (PR) is one that remains
inactive or without updates for a period of 45 days. When an issue or PR
becomes stale, it is labelled as `stale`. Normally maintainers will
comment on stale issues or PRs to prompt participants to take action. If
there is no activity for additional 30 days, this issue or PR will be
closed. If an update/comment occur on stale issues or pull requests, the
stale label will be removed, and the timer will restart"

Signed-off-by: Yi Zha <yizha1@microsoft.com>

---------

Signed-off-by: Yi Zha <yizha1@microsoft.com>
@yizha1
Copy link
Contributor Author

yizha1 commented Apr 13, 2024

@priteshbandi @shizhMSFT @FeynmanZhou @toddysm Would you mind reviewing this PR again, which has been open quite a long time?

Please be aware of some updates on the milestone naming according to Toddy's comment to bring more claritiy.

  • Change Future milestone to backlog milestone
  • Change Discuss milestone to in dicussion (or maybe we can remove this milestone, but label related issues and PRs need dicussion

@yizha1 yizha1 linked an issue Apr 13, 2024 that may be closed by this pull request
Copy link

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM

@yizha1 yizha1 merged commit a70c9c6 into notaryproject:main Apr 20, 2024
1 check passed
@yizha1 yizha1 deleted the contri_guide branch April 20, 2024 01:18
JeyJeyGao pushed a commit to notaryproject/notation-go that referenced this pull request May 29, 2024
This PR enables the `notation-go` repo to run stale action at 1:30 every
day to label or close stale PRs and issues. See guideline
https://github.com/marketplace/actions/close-stale-issues

This is the definition for stale PRs or issues that we discussed during
community call and to be updated in [contributing
PR](notaryproject/.github#25).

"A stale issue is one that remains inactive or without updates for a
period of 60 days. A stale pull request (PR) is one that remains
inactive or without updates for a period of 45 days. When an issue or PR
becomes stale, it is labelled as `stale`. Normally maintainers will
comment on stale issues or PRs to prompt participants to take action. If
there is no activity for additional 30 days, this issue or PR will be
closed. If an update/comment occur on stale issues or pull requests, the
stale label will be removed, and the timer will restart"

Signed-off-by: Yi Zha <yizha1@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
7 participants