Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 1.44 KB

Contributing to plogs

We want to make contributing to this project as easy and transparent as possible.

Project structure

  • main.go - main function with entrypoint to app.
  • ineternal - Contains internal packages
    • plogs - Functions for reteriving logs from pod.
    • colors - Colorizing functions and color codes.
    • client - Kubernetes client setup

Commits

Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits.

  <type>[<scope>]: <short summary>
     │      │             │
     │      │             └─> Summary in present tense. Not capitalized. No
     |      |                 period at the end. 
     │      │
     │      └─> Scope (optional): eg. common, compiler, authentication, core
     │
     └─> Type: chore, docs, feat, fix, refactor, style, or test.

You can follow the documentation on their website.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

License

By contributing to plogs, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.