Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (54 loc) · 6.61 KB

CONTRIBUTING.md

File metadata and controls

84 lines (54 loc) · 6.61 KB

Contributing to Kainos Core

Thank you for taking the time to contribute

Table Of Contents

How Can I Contribute?

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Kainos Core. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check open issues to confirm that the bug has not already been reported.

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

  • **You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue on this repository and sufficient information.

Explain the problem and include additional details to help maintainers reproduce 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 Kainos Core, e.g. which command exactly you used in the terminal, or how you started Kainos Core otherwise. When listing steps, don't just say what you did, but explain how you did it.
  • 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 screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • If you're reporting that Kainos Core crashed, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in Console.app under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
  • If the problem is related to performance or memory, include a CPU profile capture with your report.
  • 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.

Include details about your configuration and environment:

  • Which version of Kainos Core are you using?
  • What's the name and version of the OS you're using?
  • Are you running Kainos Core in a virtual machine? If so, which VM software are you using and which operating systems and versions are used for the host and the guest?

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Kainos Core, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

Before creating enhancement suggestions, please check open issues to confirm that the enhancement has not already been suggested.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue on this repository and sufficient 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.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Kainos Core which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful
  • Specify which version of Kainos Core you're using.
  • Specify the name and version of the OS you're using.

Local development

Kainos Core Core and all packages can be developed locally:

Pull Requests

The process described here has several goals:

  • Maintain Kainos Core's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Kainos Core
  • Enable a sustainable system for Kainos Core's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

After you submit your pull request, verify that all status checks are passing

What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.