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

docs: improve CONTRIBUTING.md #951

Merged
merged 1 commit into from Jul 1, 2018
Merged

Conversation

@jorsol
Copy link
Member

@jorsol jorsol commented Sep 19, 2017

This is a rewrite of CONTRIBUTING.md to have clear sections about
how to contribute (code, docs, ideas, issues) to the project.

[skip ci]

@jorsol jorsol changed the title WIP: docs: improve CONTRIBUTING.md docs: improve CONTRIBUTING.md Nov 27, 2017
@vlsi vlsi force-pushed the pgjdbc:master branch from 4a6d1d1 to 5819f31 Jan 17, 2018
@vlsi
vlsi approved these changes Jun 30, 2018
Copy link
Member

@vlsi vlsi left a comment

+1

Pull requests are not merged directly into the master branch is a bit weird, however it looks like a great improvement.


1. API changes require discussion, use cases, etc. Code comes later.
2. Pull requests are great for small fixes for bugs, documentation, etc.
3. Pull requests are not merged directly into the master branch.

This comment has been minimized.

@vlsi

vlsi Jun 30, 2018
Member

Does that mean "pull requests are typically squashed and put as a single commit on top of master branch"?
I would avoid "not" and just phrase the item so it is clear what actually happens.

This comment has been minimized.

@jorsol

jorsol Jul 1, 2018
Author Member

Probably I would rephrase it to something like "Pull request needs to be approved and merged by maintainers into the master branch", others ideas are welcome.

This comment has been minimized.

@vlsi

vlsi Jul 1, 2018
Member

That sounds good. I was just puzzled what not merged directly meant

1. API changes require discussion, use cases, etc. Code comes later.
2. Pull requests are great for small fixes for bugs, documentation, etc.
3. Pull requests are not merged directly into the master branch.
4. Pull requests needs to fully pass CI tests.

This comment has been minimized.

@vlsi

vlsi Jun 30, 2018
Member

modulo flaky Travis jobs

This is a rewrite of CONTRIBUTING.md to have clear sections about
how to contribute (code, docs, ideas, issues) to the project.

This is a work in progress, I send it now to remind me working on it.

[skip ci]
@jorsol jorsol force-pushed the jorsol:improve-contributing branch from 59f25ba to 19a3235 Jul 1, 2018
@vlsi vlsi merged commit 38c8845 into pgjdbc:master Jul 1, 2018
@bokken bokken mentioned this pull request Jul 3, 2018
rhavermans added a commit to bolcom/pgjdbc that referenced this pull request Jul 13, 2018
This is a rewrite of CONTRIBUTING.md to have clear sections about
how to contribute (code, docs, ideas, issues) to the project.

[skip ci]
rhavermans added a commit to bolcom/pgjdbc that referenced this pull request Jul 13, 2018
This is a rewrite of CONTRIBUTING.md to have clear sections about
how to contribute (code, docs, ideas, issues) to the project.

[skip ci]
davecramer added a commit to davecramer/pgjdbc that referenced this pull request Jul 5, 2021
This is a rewrite of CONTRIBUTING.md to have clear sections about
how to contribute (code, docs, ideas, issues) to the project.

[skip ci]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants