Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
117 lines (79 loc) · 8.47 KB

CONTRIBUTING.md

File metadata and controls

117 lines (79 loc) · 8.47 KB

Contributing to sportdata-api-client Project

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to sportdata-api-client. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

I don't want to read this whole thing, I just have a question!!!

How Can I Contribute?

Styleguides

I don't want to read this whole thing I just have a question

Please file an issue labelled help wanted to ask a question. There is no message board at this point.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for sportdata-api-client. Following these guidelines helps to understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

  • Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue on this repository and provide the following information.

Explain the problem and include additional details to help reproducing the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started your application, e.g. which command exactly you used in the terminal, or how you started it otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you made a request, explain how you submitted it to the client, how your client was configured and what parameters you used.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include log files and screen shots which show you following the described steps and clearly demonstrate the problem.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Provide more context by answering these questions:

  • Can you reproduce the problem?
  • Did the problem start happening recently (e.g. after updating to a new version of sportdata-api-client) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of sportdata-api-client? What's the most recent version in which the problem doesn't happen? You can download older versions of sportdata-api-client from the releases pages.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • Which version of sportdata-api-client are you using? You can get the exact version by checking out your application's POM file (section dependencies).
  • What Java version do you use? You shall use at least Java 11 and preferrably the latest patch.
  • Are you using your own derived classes of sportdata-api-client? If so, provide the source of those classes, preferably in a code block or with a link to a gist.

Attention! Do not include any API key, password or secret in your issue description or its attachments. Blank them out as ****** or replace them by mypassword instead.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for sportdata-api-client, including completely new features and minor improvements to existing functionality. Following these guidelines helps to understand your suggestion 📝 and find related suggestions 🔎.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.

Before Submitting An Enhancement Suggestion

  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue on this repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most sportdata-api-client users and isn't something that can or should be implemented as custom configuration.
  • List some other implementations and configurations where this enhancement exists.
  • Which version of sportdata-api-client are you using? You can get the exact version by checking out your application's POM file (section dependencies).

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • When only changing documentation, include [ci skip] in the commit title
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings

Documentation Styleguide

Use the Markdown syntax for documentation files.