Skip to content

Add a quick tour of the project to CONTRIBUTING #30187

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

Merged
merged 6 commits into from
May 7, 2018
Merged

Add a quick tour of the project to CONTRIBUTING #30187

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4a48aac
Add a quick tour of the project to CONTRIBUTING
nik9000 Apr 26, 2018
f32f950
Reorganize
nik9000 Apr 27, 2018
c5fcc61
Cleanup
nik9000 Apr 30, 2018
baad66d
:
nik9000 Apr 30, 2018
3de0f14
less dots
nik9000 Apr 30, 2018
6e8a4de
Sneaky `
nik9000 May 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ Before submitting your changes, run the test suite to make sure that nothing is
### Project layout

This repository is split into many top level directories. The most important
Copy link
Member

Choose a reason for hiding this comment

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

"consists of" vs. "split"? Maybe not that important.

Copy link
Member Author

Choose a reason for hiding this comment

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

I like to pick shorter words.

ones are
ones are:

#### `docs`
Documentation for the project.
Expand Down Expand Up @@ -269,7 +269,7 @@ disabled
* Tests that need to do strange things like install plugins that thrown
uncaught `Throwable`s or add a shutdown hook
But we're not convinced that all of these things *belong* in the qa directory.
We're fairly sure that tests that require multiple modules or plugins to work
We're fairly sure that tests that require multiple modules or plugins to work`
Copy link
Member

Choose a reason for hiding this comment

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

nit: how did the backtick sneak in? Does it to anything?

Copy link
Member

Choose a reason for hiding this comment

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

nit: how did the backtick sneak in? Does it to anything?

Copy link
Member Author

Choose a reason for hiding this comment

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

Indeed. Typo.

should just pick a "home" plugin. We're fairly sure that the multi-version
tests *do* belong in qa. Beyond that, we're not sure. If you want to add a new
qa project, open a PR and be ready to discuss options.
Expand Down