Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (32 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 1.94 KB

Contributing to Knexa

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

Knexa is an open-source project, and we love receiving contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into Knexa itself.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Knexa. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible.
  • Provide specific examples to demonstrate the steps.

Pull Requests

The process is described here:

  1. Fork the repo on GitHub.
  2. Clone the project to your own machine.
  3. Create a branch for your feature or fix (git checkout -b feature/amazing-feature).
  4. Commit changes to your own branch.
  5. Push your work back to your fork.
  6. Submit a Pull Request so that we can review your changes.

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Development Setup

  1. Install Python 3.9 or higher.
  2. Install virtualenv: pip install virtualenv
  3. Create a virtual environment: virtualenv venv
  4. Activate the virtual environment: source venv/bin/activate
  5. Install dependencies: pip install -r requirements.txt

Coding Standards

  • Follow PEP 8.
  • Use type hints (typing module) wherever possible.
  • Add docstrings to all modules, classes, and functions.
  • Write unit tests for new features.

Thank you for contributing!