Skip to content

Latest commit

 

History

History
74 lines (41 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

74 lines (41 loc) · 3.38 KB
Raw

Contribution Guidelines for Myte 😎

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

Thank you for considering contributing to Myte! This document 📖 outlines the guidelines for contributing to this project. Please take a moment to review these guidelines 📜 before submitting any contributions.

Project Overview 😋

Myte is a simple command-line 💻 tool for creating boilerplate code for Python web projects. It simplifies the project setup process by providing a user-friendly interface to choose the project name, framework, and setup complexity.

The following is a set of guidelines for contributing to Myte. These are mostly guidelines, not rules❌. Use your best judgment, and feel free to propose changes ✅ to this document in a pull request.

Getting Started 👨🏾‍💻

Before you start contributing to Myte, make sure you have the following:

  • ✅ Python (3.6 or higher) installed on your system.

How to Contribute 🐍

  1. Fork the Repository: 🍴 Start by forking the Myte repository to your GitHub account.

  2. Clone the Repository: 🤸🏾‍♂️ Clone the forked repository to your local development environment.

Issue Tracker 🐞

If you encounter any issues while using Myte, please before opening an issue, ensure similar issues has not been reported already, if it has been previously reported, just comment under that issue, else report them in the issue tracker. Please include as much detail as possible, including steps to reproduce the issue.

If you find a security vulnerability, do NOT open an issue. Email security@myte.samdoghor.com instead.

If you discover a bug or other issue, please open an issue on GitHub. Be sure to include:

  • Expected behavior
  • Actual behavior
  • Steps to reproduce the problem
  • Error messages, stack traces, and operating system info

See Issues

Suggesting Enhancements ✨

Enhancement suggestions are welcome and encouraged! Please open an issue explaining your idea.

Contributing Code 💻

Pull requests are the way to go here. Please follow these steps:

  • Make your suggested code changes
  • Ensure the test suite passes
  • Issue a pull request detailing your changes
  • Make sure to abide by the coding conventions used throughout the project (indentation, accurate comments, etc.). Test your code thoroughly.

Code style 🎀

We follow the PEP 8 style guide for Python code. Please make sure your code conforms to this style guide before submitting a pull request.

Documentation 📗

If you are adding a new feature to Myte, please also update the documentation to reflect your changes.

Testing 💨

We use the unittest testing framework for Myte. Please make sure your changes pass all existing tests before submitting a pull request.

Code of Conduct 👩🏾‍⚖️

Please review and adhere to our Code of Conduct to maintain a positive and inclusive environment for all contributors. We expect all contributors to follow our code of conduct, which can be found in the CODE_OF_CONDUCT.md file.

License

Myte is licensed under the MIT License. By contributing to this project, you agree to license your contributions under the same license.

Thanks for helping make Myte better! 🚀