Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

45 lines (34 loc) · 1.43 KB
Raw

Contributing to keip

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to keip, hosted in the OctoConsulting Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening a GitHub Issue. When you do so, please include:

  • A clear and descriptive title.
  • Steps to reproduce the problem.
  • Expected behavior and actual behavior.
  • Any relevant logs or screenshots.

Suggesting Enhancements

Enhancements or new features can also be proposed by opening an issue. Please describe:

  • The enhancement you are suggesting.
  • Why you believe this enhancement would be beneficial.
  • Any relevant examples or references.

Pull Requests

  1. Fork the repository and clone it locally.
  2. Create a new branch from main: 
    git checkout -b feature/your-feature-name
  3. Make your changes.
  4. Commit your changes, including a descriptive commit message:
git commit -m "Add feature: your-feature-name"
  1. Push to your fork and submit a pull request:
git push origin feature/your-feature-name
  1. Ensure the pull request description clearly describes the problem and solution. Include the issue number if applicable.