Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 3.12 KB
Raw

Contributing to Knows 🚀

🌟 First off, thank you for considering contributing to Knows! 🌟

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. 🙌

Code of Conduct 📜

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

How Can I Contribute? 🤔

There are many ways you can contribute to Knows, like:

  • Submitting bug reports 🐛 and feature requests 💡.
  • Writing code ✍️ for new features or bug fixes.
  • Improving the documentation 📚 or README.
  • Reviewing pull requests 👀.

Reporting Bugs 🐞

Before creating bug reports, please check this list to see if one has already been created. When you are creating a bug report, please include as many details as possible:

  1. Use a clear and descriptive title for the issue to identify the problem. 🏷️
  2. Provide a step-by-step description of the issue in as many details as possible. 🛤️
  3. Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. 🔍
  4. Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior. 🕵️
  5. Explain which behavior you expected to see instead and why. 🤷
  6. Include program outputs if needed to help you demonstrate the problem. 🖼️

Suggesting Enhancements ✨

This section guides you through submitting an enhancement suggestion for Knows, including completely new features and minor improvements to existing functionality:

  1. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
  2. Describe the current behavior and explain which behavior you expected to see instead and why.

Pull Request Process 📬

  1. Fork the repository and create your branch from main. 🍴
  2. If you've added code that should be tested, add tests. 🧪
  3. Ensure the test suite passes. ✔️
  4. Make sure your code lints. 🧹
  5. Issue that pull request! 💌

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.
  • Reference issues and pull requests liberally after the first line.

Python Styleguide 🐍

All Python code should adhere to PEP 8. Google style docstrings should be used for all functions and classes. Type annotations should be used for all functions and classes.

Additional Notes 📝

Questions, comments, or suggestions? Feel free to open an issue or reach out to one of the maintainers.