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.

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

NONE: Clarify pull request rules #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

NONE: Clarify pull request rules #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 19 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,31 @@ You can build and run virtual users on MacOS, Windows or Linux. You'll need JDK

## Submitting changes

Pull requests, issues and comments are welcome. For pull requests:
Pull requests, issues and comments are welcome. Below checklist can help you to go smoothly through the review.
Please remember that common sense applies here.

### Pull Request Readiness readiness checklist

* [ ] Includes tests to exercise the new behavior and bugs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Are these checkboxes supposed to be ticked? They're not tickable.
If we want to create a literal PR checklist, we can use a PR template.

* [ ] Follows the existing style.
* [ ] Git commit message is detailed and includes context behind the change.
* [ ] If the change is related to an existing Bug Report or Feature Request,
the issue number is referenced
* [ ] For bigger changes, make sure you start a discussion first by creating
an issue and explaining the intended
change.

- Add tests for new features and bug fixes
- Follow the existing style
- Separate unrelated changes into multiple pull requests

See the [existing issues](https://ecosystem.atlassian.net/projects/JPERF/issues/?filter=allissues) for things to start contributing.

## Getting Your Pull Request Merged

All Pull Requests must be approved by at least one member of the @atlassian/jpt team
Copy link
Contributor

Choose a reason for hiding this comment

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

This is already explained and enforced by GitHub GUI.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I usually read CONTRIBUTING.md before I start to write a code. GUI explains rules at the last phase of the contribution.

Copy link
Contributor

Choose a reason for hiding this comment

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

You can read CODEOWNERS before writing code too. IMHO it's a micro-value, not worth denormalizing

before it can be merged in.

For bigger changes, make sure you start a discussion first by creating
an issue and explaining the intended change.

All the pull requests and other changes will be accepted and merged by Atlassians.
### Legal requirements

Atlassian requires contributors to sign a Contributor License Agreement,
known as a CLA. This serves as a record stating that the contributor is
Expand Down