Skip to content

Improve contributing instructions #9439

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

Improve contributing instructions #9439

wants to merge 1 commit into from

Conversation

ikedam
Copy link
Contributor

@ikedam ikedam commented May 4, 2022

What I did

  • Minor improves for contributing instructions:
    • Link to BUILDING.md for testing instructions.
    • Not that you have to build the binary prior to make e2e-compose.

Related issue

None

@ikedam
Improve contributing instructions
ce03c60 
* Link to BUILDING.md for testing instructions.
* Note that you have to build the binary prior to `make e2e-compose`.

Signed-off-by: IKEDA Yasuyuki <devld@ikedam.jp>
@glours
Copy link
Contributor

glours commented May 11, 2022

Hi @ikedam
Thanks for your contribution, maybe we can improve the user experience by automatically build the plugin before running the e2e tests by default?
I can open a PR in that way if it make more sense than updating the doc
cc @ndeloof @ulyssessouza WDYT?

@ikedam
Copy link
Contributor Author

ikedam commented May 11, 2022

automatically build the plugin before running the e2e tests by default?

All targets in Makefile are marked .PHONY, and I believe that means the plugin will be built everytime we run e2e tests. I don't think that's so useful.
It might make sense to add a new target like build-and-e2e.

@glours glours mentioned this pull request Jul 4, 2022
Merged
@glours
Copy link
Contributor

glours commented Jul 4, 2022

@ikedam I opened a new PR #9623 to propose new targets in the Makefile and update the documentation
If that's fine for you, I'll close your PR

@glours
Copy link
Contributor

glours commented Jul 5, 2022

Replace by #9623

@glours glours closed this Jul 5, 2022
@ikedam ikedam mentioned this pull request Jul 9, 2022
Merged
@ikedam
Copy link
Contributor Author

ikedam commented Jul 9, 2022

Thanks for the update.
The update for CONRTRIBUTING.md is still valid and I created #9639 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ndeloof ndeloof ndeloof approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ikedam @glours @ndeloof