Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (23 loc) · 1019 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 1019 Bytes

Contributing to Zenith

First off, thank you for considering contributing to Zenith! It's people like you that make Zenith such a great tool.

How Can I Contribute?

Reporting Bugs

  • Use a clear and descriptive title.
  • Describe the exact steps which reproduce the problem.
  • Explain which behavior you expected to see instead and why.

Suggesting Enhancements

  • Use a clear and descriptive title.
  • Provide a step-by-step description of the suggested enhancement.
  • Explain why this enhancement would be useful to most Zenith users.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Keep your code clean and document complex logic.
  4. Ensure the test suite passes.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.

Created by Aman T Shekar