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

Update docs for contacts.yaml #281

Merged
merged 6 commits into from
Nov 19, 2024

Conversation

zhijie-yang
Copy link
Collaborator

Ping the @canonical/rocks team.


Description

This PR adds the descriptions of the maintainers field in the contacts.yaml file and corresponding onboarding instructions for adding the maintainers.


Picture of a cool rock:

@zhijie-yang zhijie-yang requested a review from a team as a code owner November 5, 2024 16:11
@zhijie-yang zhijie-yang changed the title Rocks 1606/update docs for contacts yaml Update docs for contacts.yaml Nov 5, 2024
permissions to trigger the build, upload and release of your rocks. This token should never be shared with
third-parties, nor put anywhere that is publicly available.
Upon finishing the onboarding, the user should add their GitHub username to the `rockcraft.yaml` file in the
`maintainers` field of the corresponding rock. This field is a list of GitHub usernames that are allowed to
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add a reference to the README.md with the sample contacts.yaml?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thx, added.

tools/cli-client/README.md Outdated Show resolved Hide resolved
Co-authored-by: Adrian Clay Lake <clay.lake@canonical.com>
Copy link
Collaborator

@cjdcordeiro cjdcordeiro left a comment

Choose a reason for hiding this comment

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

LGTM, just left a couple of possible improvements ;)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Cristovao Cordeiro <cristovao.cordeiro@canonical.com>
@zhijie-yang zhijie-yang merged commit e358d91 into main Nov 19, 2024
8 checks passed
@zhijie-yang zhijie-yang deleted the ROCKS-1606/update-docs-for-contacts-yaml branch November 19, 2024 12:49
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.

3 participants