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 contributing guide to add additional instructions #206

Merged
merged 2 commits into from
Sep 20, 2023

Conversation

kim-tsao
Copy link
Collaborator

@kim-tsao kim-tsao commented Sep 19, 2023

What does this PR do?:

Summarize the changes. Are any stacks or samples added or updated?

This is part of the proposed Devfile Lifecycle doc. Addressing review comments for stack providers in doc https://docs.google.com/document/d/1Syr8SZyLoVGwvZTyjHnEFm9CQ3xpQ3zBgw-PLldxsNY/edit:

Stack provider should also:

  1. create an issue to track the activity of adding a new stack/sample to the registry
  2. create PR for the contribution on the repos (and list the repos to create). <-- we already have a statement in the contributing guide to create a PR
  3. ensure the container images (including references in devfile as well as pull images references in dockerfile included in the devfile) are pulled from registries that don't have a rate limit, e.g. not using docker hub.

Which issue(s) this PR fixes:

Link to github issue(s)

devfile/api#1066

PR acceptance criteria:

  • Contributing guide
    Have you read the devfile registry contributing guide and followed its instructions?
  • Test automation
    Does this repository's tests pass with your changes?
  • Documentation
    Does any documentation need to be updated with your changes?
  • Check Tools Provider
    Have you tested the changes with existing tools, i.e. Odo, Che, Console? (See devfile registry contributing guide on how to test changes)

How to test changes / Special notes to the reviewer:

@kim-tsao kim-tsao requested review from elsony and removed request for rm3l and michael-valdron September 19, 2023 18:12
@openshift-ci openshift-ci bot added the lgtm Looks good to me label Sep 19, 2023
CONTRIBUTING.md Outdated

### Contributing
1. Open an issue in the [devfile/api](https://github.com/devfile/api) repo to track adding a new stack or sample
2. Avoid using container images (check for references in the Devfile and Dockerfile) from registries (like DockerHub) that impose rate limiting.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we provide more guidance, e.g. using a mirror on quay.io, to work around the problem

Signed-off-by: Kim Tsao <[email protected]>
@openshift-ci openshift-ci bot removed the lgtm Looks good to me label Sep 19, 2023
Copy link
Contributor

@elsony elsony left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Looks good to me label Sep 20, 2023
@openshift-ci
Copy link

openshift-ci bot commented Sep 20, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: elsony, kim-tsao, maysunfaisal

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kim-tsao kim-tsao merged commit 7227ccf into devfile:main Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm Looks good to me
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants