Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 2.88 KB
Raw

Contributing to KEPLER COMMUNITY

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

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

Before creating bug reports, please check the issue list as you might find that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title.
  • Describe the exact steps that reproduce the problem.
  • Provide specific examples to demonstrate the steps.
  • Describe the behavior you observed after following the steps.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots if possible.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues and Discord channels. When creating an enhancement suggestion, please include:

  • A clear and descriptive title.
  • A detailed description of the proposed functionality.
  • Explain why this enhancement would be useful.
  • List any similar features in other browsers if you know of any.

Pull Requests

When submitting a pull request, please follow these guidelines:

  • Fill in the Required Template: Ensure all sections of the pull request template are completed.
  • PR Title: Do not include issue numbers in the PR title.
  • Visual Aids: Include screenshots and animated GIFs in your pull request whenever possible.
  • Coding Standards: Follow the Python style guide.
  • Testing: Include tests when adding features.
  • Documentation: Document new code and any changes.

Development Process

  1. Fork the Repository: Create a personal fork on GitHub.
  2. Create a New Branch: Use a descriptive branch name for your feature or bug fix.
  3. Make Your Changes: Implement your feature or fix the bug.
  4. Run the Tests: Ensure all tests pass before committing your changes.
  5. Push Your Changes: Push to your forked repository.
  6. Create a Pull Request: Submit your changes for review.

Style Guide

Consistency is important for the readability of the project. Please follow these guidelines:

  • Indentation: Use 4 spaces for indentation.
  • PEP 8: Follow PEP 8 guidelines for Python code.
  • Variable names: Use meaningful variable names and descriptive variable names.
  • Comments: Add comments for complex logic or hard to understand code.
  • Functions: Keep functions small and focused or split them into smaller functions.

Getting Help

If you need assistance, you can:

Thank you for contributing! ✨