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 contribution instructions. #2669

Merged
merged 4 commits into from
Oct 13, 2017

Conversation

SomeoneToIgnore
Copy link
Contributor

@SomeoneToIgnore SomeoneToIgnore commented Oct 12, 2017

This change is Reviewable

@gilberto-torrezan
Copy link
Contributor

Reviewed 2 of 2 files at r1.
Review status: all files reviewed at latest revision, 3 unresolved discussions, some commit checks failed.


CONTRIBUTING.md, line 118 at r1 (raw file):

This also goes for features that are hard to test automatically.

After submitting a pull request, our CI system will trigger the verification build automatically, including integration tests and you will be able to see the whole build output and results.

Is it possible to provide a link to our CI system here?


README.md, line 75 at r1 (raw file):

To run IT tests locally, you'll need a [Testbench](https://vaadin.com/testbench) license and a Chrome browser installed (currently this is the only browser that IT tests are run in).
If you don't have the license, it's ok, our CI will run those tests for you after you create a pull request. 

... our CI servers will run. CI alone is a bit strange


README.md, line 79 at r1 (raw file):

When running IT tests locally, by default, local Chrome is used to run tests.
The other opportunity is to run tests using test hub, to do so, you need to start a hub and start tests with `-Dtest.use.hub=true -Dcom.vaadin.testbench.Parameters.hubHostname="foo"` properties.

Do we have a link about these test hubs and how do they work (and what is the foo property there)? If so, you could put it here.


Comments from Reviewable

@SomeoneToIgnore
Copy link
Contributor Author

Review status: all files reviewed at latest revision, 3 unresolved discussions.


CONTRIBUTING.md, line 118 at r1 (raw file):

Previously, gilberto-torrezan (Gilberto Torrezan) wrote…

Is it possible to provide a link to our CI system here?

I would prefer to avoid it:

  1. Current TeamCity login page has rather small button for guest login, should be explained also, rather bothersome
  2. If we migrate to another CI, we would be forced to change it everywhere
  3. What value does it bring to the users? They will get the url when submin the PR.

README.md, line 75 at r1 (raw file):

Previously, gilberto-torrezan (Gilberto Torrezan) wrote…

... our CI servers will run. CI alone is a bit strange

Well, strictly speaking, CI servers are not ours. Have adjusted it a bit.


README.md, line 79 at r1 (raw file):

Previously, gilberto-torrezan (Gilberto Torrezan) wrote…

Do we have a link about these test hubs and how do they work (and what is the foo property there)? If so, you could put it here.

Removed completely, doubt that an external contributor would pick launching Selenium cluster over installing Chrome.


Comments from Reviewable

@gilberto-torrezan
Copy link
Contributor

Reviewed 1 of 1 files at r2.
Review status: all files reviewed at latest revision, all discussions resolved.


Comments from Reviewable

@SomeoneToIgnore SomeoneToIgnore merged commit 28a3acc into master Oct 13, 2017
@SomeoneToIgnore SomeoneToIgnore deleted the kb/2668_update-contribution-instructions branch October 13, 2017 08:47
@SomeoneToIgnore SomeoneToIgnore added this to the 1.0.0.alpha6 milestone Oct 19, 2017
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

Successfully merging this pull request may close these issues.

3 participants