Skip to content

Latest commit

 

History

History
233 lines (158 loc) · 7.7 KB

CONTRIBUTING.md

File metadata and controls

233 lines (158 loc) · 7.7 KB
Raw

Contributing

Introduction

insights-core is the framework upon which Red Hat Insights rules are built and delivered. The basic purpose is to apply "rules" to a set of files collected from a system at a given point in time.

insights-core rule "plugins" are written in python. The rules follow a "MapReduce" approach, dividing the logic between "mapping" and "reducing" methods. This is a convenient approach where a rule's logic takes place in two steps. First, there is a "gathering of facts" (the map phase) followed by logic being applied to the facts (the reduce phase).

Rule Development Setup

Clone the project:

git clone git@github.com:RedHatInsights/insights-core.git

Or, alternatively, using HTTPS:

git clone https://github.com/RedHatInsights/insights-core.git

Initialize a virtualenv:

cd insights-core
python3 -m venv .python3
source .python3/bin/activate
pip install --upgrade pip

Install the project and its dependencies:

pip install -e .

Install a rule repository:

pip install -e path/to/rule/repo

Contributor Setup

If you wish to contribute to the insights-core project you'll need to create a fork in GitHub.

  1. Clone your fork:

    git clone git@github.com:your-user/insights-core.git

  2. Reference the original project as "upstream":

    git remote add upstream git@github.com:RedHatInsights/insights-core.git

At this point, you would synchronize your fork with the upstream project using the following commands:

git pull upstream master
git push origin master

Python

To setup the project virtualenv, use the following commands

cd insights-core
python3 -m venv .python3
source .python3/bin/activate
pip install --upgrade pip
pip install -e .[develop]

After setup

You can validate the setup by running the unit tests.

py.test

To generate docs:

cd docs/
make html

And they can be found under docs/_build/html.

Contributor Submissions

Contributors should submit changes to the code via GitHub "Pull Requests." One would normally start a new contribution with a branch from the current master branch of the upstream project.

  1. Synchronize your fork as described in the Contributor Setup above

  2. Make a branch on the fork. Use a branch name that would be meaningful as it will be part of a default commit message when the topic branch is merged into the upstream project

    git checkout -b your-topic

  3. Make contributions on the topic branch. This project uses the DCO to manage contributions. Commits must be signed by you in order to be accepted. To sign a commit simply add -s to the commit command.

    git commit -s

    Push commits to your fork (creating a remote topic branch on your fork)

    git push

  4. If you need to make updates after pushing, it is useful to rebase with master. This will change history, so you will need to force the push (this is fine on a topic branch when other developers are not working from the remote branch.)

    git checkout master
git pull --rebase upstream master
git push
git checkout your-topic
git rebase master
git push --force

  5. Generally, keep the number of commits on the topic branch small. Usually a single commit, perhaps a few in some cases. Use the amend and rebase -i git commands to manage the commit history of the topic branch. Again, such manipulations change history and require a --force push.

  6. When ready, use the GitHub UI to submit a pull request. Fill out the information requested in the PR template. If your PR fixes an issue make sure to reference the issue using a keyword so that it will be closed once your PR is merged.

  7. Repeat steps 4 and 5 as necessary. Note that a forced push to the topic branch will work as expected. The pull request will be updated with the current view of the topic-branch.

Style Conventions

Code Style

Code style mostly follows PEP8. The style followed is essentially encoded in the flake8 configuration file in the repo's root directory. The current configuration specifies the following rules as exceptions

  • E501: Line too long
  • E126: Continuation line over-indented for hanging indent
  • E127: Continuation line over-indented for visual indent
  • E128: Continuation line under-indented for visual indent

In some cases, a particular bit of code may require formatting that violates flake8 rules. In such cases, one can, for example, annotate the line with # noqa. Override flake8 checking sparingly.

Code that does not pass the project's current flake8 tests will not be accepted.

Commit Message Style

Commit messages are an important description of changes taking place in the code base. So, they should be effective at providing useful descriptions of the changes for someone browsing the git log.

Generally, they should follow the usual git conventions.

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain the what and why vs. how

Documentation

Code should generally be clear enough to self-document the how of the implementation. Of course, when a bit of code isn't clear, comments may be needed.

Documentation in the form of pydoc should be considered to document usage of code as necessary. In particular, code used by rule developers should be carefully documented. They should be able to use generated documentation to understand, for example, the data models exposed by parser classes.

Review Checklist

The following checklist is used when reviewing pull requests

General (all submissions)

  • Commit messages are useful and properly formatted
  • No sensitive personally identifiable information (PII) is included in any types of files nor docstring
  • Unit tests validate the code submission
  • One commit, or at most only a handful. More than five commits should be heavily questioned

About Sensitive PII

Component (Datasources, Components, Parsers, and Combiners)

  • Component is properly documented and should include:

    • Example input
    • The resulting data structure represented by the component
    • Component usage is clear to a user with some knowledge of the domain without needing to examine the code itself
    • Meaning and usage of an "empty" (falsy data object) is clear

  • Unit tests cover both positive and negative cases and utilizes reasonable examples of input data. Test data should be usable in the generation in archives used for integration testing and product demonstrations.

    • 100% branch coverage is recommended
    • Codecov Action is used in insights-core. You can check the project coverage report here or check the PR's detailed coverage in your PR page.

  • Do not expose a defaultdict or any other data structure that would mutate as a side effect of accessing the object.