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

Guidelines for contributing #3291

Closed
akarnokd opened this issue Sep 3, 2015 · 0 comments
Closed

Guidelines for contributing #3291

akarnokd opened this issue Sep 3, 2015 · 0 comments

Comments

@akarnokd
Copy link
Member

akarnokd commented Sep 3, 2015

As called for by #3145, I'd like to collect the checkpoints one has to conform with when posting a PR:

Style

  • Use 4 spaces instead of tabs
  • Use single newline (not cr+lf)
  • Otherwise, there aren't any concrete style requirements.

When changing existing content:

  • Don't change existing unit tests unless you are fixing a bug in them.
  • Don't rename existing classes, fields and local variables unless you are fixing a bug or doing (performance) improvements and even then, limit yourself to the target area.
  • Generally try to avoid cosmetic or style changes.

When proposing new content:

  • Take into account that accepting new public API extensions (i.e., operator on Observable or anything outside rx.internal) may take weeks to accept and several rounds of review.
  • Make sure the proposed operator has sufficient amount of tests. If the operator is involved in concurrency or coordination, have looped unit tests that test for concurrent behavior for a certain number of rounds (but don't make it take minutes to complete).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant