-
-
Notifications
You must be signed in to change notification settings - Fork 650
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
consolidate and streamline contribution docs #494
Conversation
@AlexeySoshin @onsi does this look good to you ? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for helping @grosser!
Please see comments above, I am happy to support in case you have doubts.
CONTRIBUTING.md
Outdated
|
||
``` | ||
git clone git@github.com:<NAME>/ginkgo.git $GO_PATH/src/github.com/<NAME>/ginkgo` | ||
go get github.com/onsi/gomega |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you need to install gomega
using go get github.com/onsi/gomega/...
(see the "...")
CONTRIBUTING.md
Outdated
## Making the PR | ||
- make your changes | ||
- run tests and linter again (see above) | ||
- run `/after_pr.sh` to undo modifications |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
after_pr.sh
does not exist anymore I think
CONTRIBUTING.md
Outdated
|
||
./before_pr.sh # replace imports to test internal packages | ||
ginkgo -r -p # ensure tests are green | ||
go vet ./... # ensure linter is happy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently, this does not work from a fork. So, I think we should fix that before merging this PR.
I have opened #496 to track the bug I am seeing when running the tests in a fork. |
finally go the tests running, the issue was that extensions/table/table.go had ... maybe this is just the wrong approach and the fork should be kept under |
I'd think the current state is already a step forward, so maybe merge and then do adjustments in future PRs ? |
CONTRIBUTING.md
Outdated
Fork the repo, then: | ||
|
||
``` | ||
git clone git@github.com:<NAME>/ginkgo.git $GO_PATH/src/github.com/<NAME>/ginkgo` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a typo $GO_PATH
should be $GOPATH
CONTRIBUTING.md
Outdated
``` | ||
|
||
## Making the PR | ||
- make your changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add git commit
here? Otherwise git checkout .
suggested as later step would revert the changes.
I agree that's good improvement, thank you for that! I have added a few comments, let me know what you think. Also, what is the output you are getting when you run the steps? Do the tests pass? |
I had a thought about it. I think that current flow we are suggesting is not right. In my opinion the steps should be:
Tests should always pass because the imports won't change. What do you think @grosser ? |
updated ... much simpler and less juggling things around when trying to make a PR |
LGTM, thanks @grosser ! 🎉 |
thx 🎉 |
solves #492 (comment)
before:
after: