Skip to content

Clarify contributing guidelines #616

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
JordanMartinez merged 2 commits into from
Oct 14, 2017
Merged

Clarify contributing guidelines #616

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d27bec
Clarify contributing guidelines for issue reporting and demo PRs
JordanMartinez Oct 14, 2017
5a32e77
Remove "Merging Pull Requests" section; update state of committers
JordanMartinez Oct 14, 2017
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
21 changes: 14 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@

## Merging pull requests
## Issue Reporting

Commiters can merge pull requests. If you are a committer, please follow these (rather informal) rules when merging a pull request:
- Provide your environment info (OS, RTFX version, Java version)
- If issue is a bug:
- at the very least, provide copy-and-paste code as an Application that reproduces bug/issue
- at the very best, provide copy-and-paste code as a TestFX test that reproduces the bug/issue when run
- If issue is a question, explain your use case (the why) and the desired outcome and (if applicable) a photo showing that (the goal). We'll discuss the implementation (the how) in the issue.

- When a pull request is a no brainer (by your best judgment), go ahead and merge it.
- When in doubt, seek an opinion of at least one more committer and work with the proponent of the PR until all involved committers (including you) give a :+1:.
## PR guidelines for demo package

- Modulate the code to multiple classes (if things cannot be set up in `Application#start`, helper methods, or code would be better understood as a separate class).
- Add the suffix "Demo" to the demo class that extends `Application` (e.g. `RichTextDemo`), so that people know which class is the demo and which classes are things used eventually in the demo
- If demo is a single class, put it in topmost package (e.g. `org.fxmisc.richtext.demo`)
- If demo requires multiple classes, put it and the classes it uses into its own package (e.g. `org.fxmisc.richtext.demo.mydemo`).

## List of committers

- [TomasMikula](https://github.com/TomasMikula)
- [JordanMartinez](https://github.com/JordanMartinez)
- [afester](https://github.com/afester)
- [TomasMikula](https://github.com/TomasMikula) - original contributor, currently inactive
- [JordanMartinez](https://github.com/JordanMartinez) - later contributor, currently active
- [afester](https://github.com/afester) - later contributor, sometimes active
⚡