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

Clarify contributing guidelines #615

Closed
JordanMartinez opened this issue Oct 14, 2017 · 2 comments
Closed

Clarify contributing guidelines #615

JordanMartinez opened this issue Oct 14, 2017 · 2 comments

Comments

@JordanMartinez
Copy link
Contributor

The following need to be added/clarified in CONTRIBUTING.md:

Issue Reporting

  • Environment info (OS, RTFX version, Java version)
  • If issue is a bug: at the very least, provide code as an Application that reproduces bug/issue; at the very best, provide code as a TestFX test that reproduces the bug/issue
  • If issue is a question, explain the desired outcome and a photo showing that (if applicable)

PR guidelines

  • style guidelines (usage of blank lines in code [e.g. before/after curly braces] among other things)

PR guidelines for demo package

  • Add the suffix "Demo" to the demo, so that people know which class is the demo and which classes are things used eventually in the demo
  • 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.
  • If demo is a single class, put it in topmost package; if it requires multiple classes, put it and the classes it uses into its own package.
@JordanMartinez
Copy link
Contributor Author

JordanMartinez commented Oct 14, 2017

PR guidelines
style guidelines (usage of blank lines in code [e.g. before/after curly braces] among other things)

This guideline is better enforced (like what TestFX does) than explained

@JordanMartinez
Copy link
Contributor Author

Since the style guideline is it's own separate issue, I'll open a new one for that.

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

No branches or pull requests

1 participant