Skip to content
This repository has been archived by the owner on Feb 9, 2024. It is now read-only.

Latest commit

 

History

History
62 lines (42 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 3.3 KB
Raw

Do’s and Don’ts

  • Search tickets before you file a new one. Add to tickets if you have new information about the issue.
  • Keep tickets short but sweet. Make sure you include all the context needed to solve the issue. Don't overdo it. Great tickets allow us to focus on solving problems instead of discussing them.
  • Take care of your ticket. When you spend time to report a ticket with care we'll enjoy fixing it for you.
  • Use GitHub-flavored Markdown. Especially put code blocks and console outputs in backticks (```). That increases the readability. Bonus points for applying the appropriate syntax highlighting.
  • Do not litter. Don’t add +1’s unless specifically asked for and don’t discuss offtopic issues.

Bug Reports

In short, since you are most likely a developer, provide a ticket that you yourself would like to receive.

We are not here to support your individual projects. We depend on you (the community) to contribute in making the project better for everyone. So debug and reduce your own issues before creating a ticket and let us know of all the things you tried and their outcome. This applies double if you cannot share a reproduction with us because of internal company policies.

First check if you are using the latest CoroutineWorker version and Kotlin version before filing a ticket.

Please include steps to reproduce and all other relevant information, including any other relevant dependency and version information.

If you are familiar with Kotlin, making a pull request with a failing test case can speed up the resolution of the bug. We would greatly appreciate it!

Feature Requests

Please try to be precise about the proposed outcome of the feature and how it would related to existing features.

Pull Requests

We love pull requests!

All contributions will be licensed under the Apache 2.0 license.

Code/comments should adhere to the following rules:

  • Names should be descriptive and concise.
  • Use four spaces and no tabs.
  • All changes require test coverage to ensure it does not break during refactor work, as well as ensure consistent behavior across supported platforms.
  • Comments are required for public APIs and use JavaDoc format.
  • When documenting APIs and/or source code, don't make assumptions or make implications about race, gender, religion, political orientation, or anything else that isn't relevant to the project.
  • Remember that source code usually gets written once and read often: ensure the reader doesn't have to make guesses. Make sure that the purpose and inner logic are either obvious to a reasonably skilled professional, or add a comment that explains it.
  • Pull requests will be squashed and merged. Please add a detailed description; it will be used in the commit message and paraphrased in release notes.

If you consistently contribute improvements and/or bug fixes and are an exemplar of our code of conduct, we're happy to make you a maintainer.

No Brown M&M’s

If you made it all the way to the end, bravo dear user, we love you. You can include this emoji in the top of your ticket to signal to us that you did in fact read this file and are trying to conform to it as best as possible: 🌮