Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 7.09 KB

CONTRIBUTING.md

File metadata and controls

90 lines (59 loc) · 7.09 KB
Raw

Contributing to CLIParser

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to CLIParser, which are hosted in the MASES Group Organization on GitHub. Feel free to propose changes to this document in a pull request. We are trying to have a common idea between all partecipant.

Code of Conduct

This project and everyone participating in it is governed by the CLIParser Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Project organization

The project is organized in this folder structure:

  • docs (website)
  • sc
    • CLIParser (The folder containing the source and project of the parser)
  • tests
    • CLIParserTest (The folder containing the source and project of the CLIParser test)
  • third_party (The folder containing external projects used from this repository)

How Can I Contribute?

Work on the project

An user who wants to help us can do what is described in the following chapters.

Development improvements

If you are a developer and want to contribute you are welcome.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for CLIParser, 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 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. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue on that 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.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of CLIParser which the suggestion is related to.
  • Explain why this enhancement would be useful to most CLIParser users.
  • Specify which version of CLIParser you're using.
  • Specify the name and version of the OS you're using.

Reporting Bugs

This section guides you through submitting a bug report for CLIParser. 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.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue on that repository and provide the following information by filling in the template.

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 CLIParser, e.g. which command exactly you used in the terminal, or how you started CLIParser otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an CLIParser command, and if so which one?
  • 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. If you use the keyboard while following the steps, record the GIF with the Keybinding Resolver shown.
  • If you're reporting that CLIParser 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.

Provide more context by answering these questions:

  • Can you reproduce the problem in safe mode?
  • Did the problem start happening recently (e.g. after updating to a new version of CLIParser) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of CLIParser? What's the most recent version in which the problem doesn't happen? You can download older versions of CLIParser from the releases page.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
  • If the problem is related to working with files (e.g. opening and editing files), does the problem happen for all files and projects or only some? Does the problem happen only when working with local or remote files (e.g. on network drives), with files of a specific type (e.g. only JavaScript or Python files), with large files or files with very long lines, or with files in a specific encoding? Is there anything else special about the files you are using?

Include details about your configuration and environment:

  • Which version of CLIParser are you using?
  • What's the name and version of the OS you're using?
  • Are you running CLIParser 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?
  • Are you using CLIParser with multiple monitors? If so, can you reproduce the problem when you use a single monitor?
  • Which keyboard layout are you using? Are you using a US layout or some other layout?