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

Create a contribution guide for ORAS #20

Open
FeynmanZhou opened this issue Aug 31, 2022 · 0 comments
Open

Create a contribution guide for ORAS #20

FeynmanZhou opened this issue Aug 31, 2022 · 0 comments

Comments

@FeynmanZhou
Copy link
Member

Currently, we have more contributors onboarded to the ORAS community but they feel hard to get started. It's necessary to prepare a contribution guide for new contributors. Generally, it should include the following sections:

  • Communication, proposal, and design
  • Developer guide (How to compile, build, and test locally)
  • Unit test and E2E test requirement
  • GitHub workflow
  • Open a Pull Request
  • Code review process and criteria

This is long-term work so we can start to prepare some documents in the community repo gradually. I will create a draft file to placeholder some sections above.

cc @Wwwsylvia @qweeah @oras-project/oras-maintainers for collaboration on this work.

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

No branches or pull requests

1 participant