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

Add contributor documentation and helper scripts #201

Merged
merged 11 commits into from
Jun 5, 2019

Conversation

corneliusweig
Copy link
Contributor

This still has no information for:

How to pick issues / what to do before working on an issue (maybe also add good-first-issue labels to suitable issues).

For one, I think I'm not in the position to make guidelines here. In addition, I think a process needs to be established to add appropriate labels.

See #200

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 4, 2019
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 4, 2019
@codecov-io
Copy link

codecov-io commented Jun 4, 2019

Codecov Report

Merging #201 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #201   +/-   ##
=======================================
  Coverage   53.77%   53.77%           
=======================================
  Files          13       13           
  Lines         716      716           
=======================================
  Hits          385      385           
  Misses        279      279           
  Partials       52       52

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6597914...96de068. Read the comment docs.

docs/CONTRIBUTOR_GUIDE.md Outdated Show resolved Hide resolved
hack/run-tests.sh Outdated Show resolved Hide resolved
hack/run-tests.sh Outdated Show resolved Hide resolved
hack/sandboxed.Dockerfile Outdated Show resolved Hide resolved
hack/sandboxed.Dockerfile Outdated Show resolved Hide resolved
check-code-patterns.sh -> verify-code-patterns.sh
run_lint.sh -> run-lint.sh

This ensures a more consistent naming pattern
@corneliusweig
Copy link
Contributor Author

corneliusweig commented Jun 4, 2019

Please take another look sorry, didn't see that you were reviewing all along..


WORKDIR /go/src/sigs.k8s.io/krew

# build binary
Copy link
Member

Choose a reason for hiding this comment

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

I think we really shouldn't repeat the build process here. I highly recommend we just refactor the script that starts the container to do something like:

OSARCH=linux/amd64 hack/make-binaries.sh
docker run --rm -i -t -v ./out/bin/krew-linux_amd64:/bin/krew

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm.. that will need a lot of extra work. I think I will remove the docker sandbox instead and submit that as a separate PR when gox is gone.

@ahmetb
Copy link
Member

ahmetb commented Jun 5, 2019

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 5, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, corneliusweig

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 5, 2019
@k8s-ci-robot k8s-ci-robot merged commit 3859076 into kubernetes-sigs:master Jun 5, 2019
@corneliusweig corneliusweig deleted the contributor-docs branch June 5, 2019 22:33
ahmetb added a commit to ahmetb/krew that referenced this pull request Jun 14, 2019
Adding corneliusweig to owners. He has been consistently helping both with
krew and krew-index repositories in terms of:
- developing plugins himself
- taking a stab at krew machinery with large scale code refactors
- adding integration test suite to the project
- adding more validation and test cases
- increasing developer documentation

Some of his notable work:
- kubernetes-sigs#195
- kubernetes-sigs#183
- kubernetes-sigs#191
- kubernetes-sigs#201
- kubernetes-sigs#202
- kubernetes-sigs#203
- kubernetes-sigs#208

He is familiar with the codebase enough to officially review and approve code.

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
ahmetb added a commit that referenced this pull request Jun 18, 2019
Adding corneliusweig to owners. He has been consistently helping both with
krew and krew-index repositories in terms of:
- developing plugins himself
- taking a stab at krew machinery with large scale code refactors
- adding integration test suite to the project
- adding more validation and test cases
- increasing developer documentation

Some of his notable work:
- #195
- #183
- #191
- #201
- #202
- #203
- #208

He is familiar with the codebase enough to officially review and approve code.

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants