Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 4.17 KB

CONTRIBUTING.md

File metadata and controls

84 lines (52 loc) · 4.17 KB
Raw

Contributing to Istar

First, thanks for taking the time to contribute! 😻👍

Table Of Contents

Code of Conduct

Just don't be a dick (this include bigotry).

How Can I Contribute?

Reporting Bugs

This section guide you through submitting a bug report for Istar. Following these guidelines helps maintainers and the community 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.

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.
  • 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 which clearly demonstrate the problem if needed.
  • include a stack trace
  • 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 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 Istar are you using?
  • Are you running Istar in a virtual machine? If so, which VM software are you using ?
  • Are you running Istar on real hardware? If so, provide information about it.

Your First Code Contribution

Unsure where to begin contributing to Istar? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Styleguides

Git Commit Message

Git commit message MUST follow Coventional Commits convention

Other recommandations:

  • Use the present tense ("add" instead of "added")
  • Use the imperative mood ("move cursor to..." not "moves cursor to...")

C Coding Style

You MUST follow our coding style

(This text is based on the Atom's CONTRIBUTING.md)