Skip to content

Latest commit

 

History

History
101 lines (66 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

101 lines (66 loc) · 2.7 KB
Raw

Contributing

Local Installation

git clone https://github.com/censys/censys-splunk.git

This method assumes you have Docker and Docker Compose installed and running on your server.

Run the Docker Compose file

docker-compose up

Open your browser to http://localhost:8000/ and login with your Splunk credentials.

Helpful Commands

poetry update  # Update dependencies
poetry install -E docs  # Install dependencies for documentation

Committing

This repository currently uses the rebase workflow for Merge Requests. This means that merge messages are not created when requests are merged.

Every commit in the merge request must be treated as a stand-alone, autonomous change. If this is not the case, consider using the squash feature before merging.

Commit Messages

Search is now using Conventional Commits to structure its commit messages, in the event we want to automatically generate changelogs in the future.

Commit messages should always be written as if to complete the follow sentence:

If applied, this commit will... < Insert Commit Message Here >

Type

  • fix: A bug fix.
  • feat: A new feature or component.
  • improve: A code code that is neither a new feature nor a bug fix but improves functionality.
  • refactor: A code change that is neither a new feature nor a bug fix but does not change the current functionality of the code.
  • chore: A repeatable action such as static code generation.
  • docs: Changes to documentation.
  • style: Changes that do not change the meaning of the code such as black or isort.
  • test: Changes to tests.

type: <commit message>

Finally, there is a build type which has its own set of scopes. See below.

Scope

The scope should be the name of an area of Censys Splunk Integrations. While this is certainly not an exhaustive list, please consider using an existing scope before adding a new one.

Scopes are not required, but they help keep commits succinct and autonomous.

  • docs: Changes to the documentation.

type(scope): <commit message>

Build Type and Scopes

The build type is used to represent changes to the build system or repository itself. The following scopes are recommended for use with the build commit type:

  • ci
  • chart
  • container
  • deps

VSCode Config

Please note that there is a sample vscode settings.json and extensions.json files in the .vscode directory.

FAQs

Rebasing merge conflicts when there was a new package added to poetry

Incase of poetry.lock merge conflicts

  1. Accept all incoming changes (to maintain toml validity)

  2. Rewrite the lockfile from pyproject.toml

poetry lock --no-update