Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 2.06 KB

Contributing to KivyStart

First off, thank you for considering contributing to our project! Your contributions help make this project better for everyone.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue. Include as much detail as possible:

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

Suggesting Enhancements

If you have an idea to improve the project, we'd love to hear it! Please create an issue with:

  • A clear and descriptive title.
  • A detailed explanation of the enhancement.
  • Any supporting material or examples.

Pull Requests

We welcome pull requests! If you have a fix or an enhancement, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/YourFeature).
  6. Open a pull request.

Code Style

To ensure consistency, please follow these guidelines:

  • Follow the existing code style and formatting.
  • Write clear, concise comments.
  • Write tests for new features and bug fixes.

Commit Messages

Write meaningful commit messages:

  • Use the present tense ("Add feature" not "Added feature").
  • Use imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Include relevant issue numbers (e.g., #123).

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Getting Started

To get started with development, follow these steps:

  1. Clone the repository (git clone https://github.com/digreatbrian/kivystart.git).
  2. Install dependencies (pip install -r requirements.txt, etc.).
  3. Start new project (python3 -m kivystart makeproject).

Need Help?

If you need any help or have questions, feel free to reach out by opening an issue or contacting the maintainers.

Thank you for your contributions!