Skip to content

Latest commit

 

History

History
286 lines (202 loc) · 11.3 KB

CONTRIBUTING.md

File metadata and controls

286 lines (202 loc) · 11.3 KB
Raw

Contributing to Pearl

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Pearl. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Table of Contents

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Pearl.

Before submitting a bug report

You might be able to find the cause of the problem and fix things yourself.

  • Check the troubleshooting section
  • Check if you can reproduce the problem with the latest version of Pearl
  • Check for existing open/closed issues
    • If the bug has already been suggested, 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 in the Pearl issues page. 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 Pearl, e.g. which command exactly you used in the terminal. When listing steps, don't just say what you did, but explain how you did it. For example.
  • 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.
  • Put the bug label to the issue.

Include details about your configuration and environment:

  • Which version of Pearl are you using?
  • What's the name and version of the OS you're using?
  • Are you running Pearl 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?
  • Which packages do you have installed? You can get that list by running pearl list.

Template For Submitting Bug Reports

[Short description of problem here]

**Reproduction Steps:**

1. [First Step]
2. [Second Step]
3. [Other Steps...]

**Expected behavior:**

[Describe expected behavior here]

**Observed behavior:**

[Describe observed behavior here]

**Pearl version:** [Enter Pearl version here]
**OS and version:** [Enter OS name and version here]

**Installed packages:**

[List of installed packages here]

**Additional information:**

* Problem started happening recently, didn't happen in an older version of Pearl: [Yes/No]
* Problem can be reliably reproduced, doesn't happen randomly: [Yes/No]

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Pearl, including completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion

  • Check if you're using the latest version of Pearl
  • Check for existing open/closed issues
    • If enhancement has already been suggested, 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 in the Pearl issues page.

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.
  • Specify which version of Pearl you're using.
  • Specify the name and version of the OS you're using.
  • Put the enanchement label to the issue.

Template For Submitting Enhancement Suggestions

[Short description of suggestion]

**Steps which explain the enhancement**

1. [First Step]
2. [Second Step]
3. [Other Steps...]

**Current and suggested behavior**

[Describe current and suggested behavior here]

**Why would the enhancement be useful to most users**

[Explain why the enhancement would be useful to most users]

[List some other text editors or applications where this enhancement exists]

**Pearl Version:** [Enter Pearl version here]
**OS and Version:** [Enter OS name and version here]

Your First Code Contribution

All Pearl issues are tracked as GitHub issues in the Pearl issues page.

Pull Requests

Unit Tests

To run unit tests:

make test

Integration Tests

The integration tests attempt to test Pearl code and modify the content of the $PEARL_HOME. You need to specify the Pearl code location.

For instance, to run locally the integration tests against Pearl located in $HOME/pearl using Bash, Zsh and Fish shells:

# bash ./ci/integ-tests.sh $HOME/pearl
# zsh ./ci/integ-tests.sh $HOME/pearl
# fish ./ci/integ-tests.fish $HOME/pearl

Generally, there is no need to run integration tests locally since Travis will run as soon as the pull request gets created.

Contribute to the Official Pearl Hub

Would you like to create a cool Pearl package and you want to submit it to OPH repository?

  1. Create the package starting from the template package.
  2. Create a pull request to add the new package in the OPH repository.

Styleguides

Git Commit Messages

  • Follow the seven rules of a great Git commit message
  • Reference issues and pull requests liberally
  • 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 Mac OS
    • 🏁 :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
    • 📦 :package: when bumping the version

Documentation Styleguide

Python Styleguide

Shell Styleguide

Function documentation

For function documentation follows the example below:

#######################################
# Cleanup files from the backup dir.
#
# Globals:
#   VAR1 (RO,bool)    : `my_func` access to VAR1.
#   VAR2 (WO)         : `my_func` change the value of VAR2.
#   VAR3 (RW)         : `my_func` read and write to VAR3.
# Arguments:
#   arg1 ($1,int)     : Directory to cleanup.
#   arg2 ($2-)        : Command to execute for the cleanup.
# Returns:
#   0                 : Cleanup completed successfully.
#   101               : Backup directory is not readable.
#   $NOT_DIR_ERROR    : Backup directory is not a directory.
# Output:
#   None
#######################################
my_func() {
    local arg1=$1
    shift
    local arg2=$@
    ...
}

The documentation is divided by a description of the function, a Globals, Arguments, Returns and Output sections. If a section does not need details use the word None inside of it.

Globals section provides all global variables that interact with the function.

Arguments section provides the list of arguments to pass to the function. Use the parenthesis to indicate the position of the arguments:

  • $1 : Argument is in position one.
  • $2- : Argument takes all args from position two up to the end.
  • $@ : Argument takes all args.
  • $3? : Argument is optional.

Variables defined in Globals and Arguments sections can have the following types:

  • int : Integer variable.
  • str : String variable (default).
  • bool : Bool variable.

Returns section contains the exit status of the function.

Output section describe the string printed to stdout.

Versioning

Public API

The public API refers to the following parts of Pearl system:

  • Pearl script CLI
  • The pearl-config structure (includes config.* and hooks.sh files)
  • Pearl hooks on bash, zsh, fish, vim and emacs config files in $HOME directory
  • pearl.conf file format

Any potential code change that cause backwards incompatible changes to the public API requires the major version to be incremented.