Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.4 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to the Arithmo project! We welcome contributions from the community to help improve our project.

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the Arithmo repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your desired changes to the codebase.
  5. Commit your changes and push them to your forked repository, the commit should have a emoji ✅.
  6. Submit a pull request to the main Arithmo repository.

Important

Create a virtual environment for the project before installing the dependencies.

Create an virtual environment for the project, called venv

MacOS and Linux:

$ python3 -m venv venv

Windows:

$ python -m venv venv

activate venv MacOs and Linux

source venv/bin/activate

Code Style

Please adhere to the following code style guidelines when contributing to Arithmo:

  • Follow the naming conventions for variables, functions, and classes.
  • Write clear and concise comments.
  • Use meaningful commit messages.

Reporting Issues

If you encounter any issues or bugs while using Arithmo, please report them using the issue tracker on GitHub. Provide as much detail as possible, including steps to reproduce the issue and any relevant error messages.

Contact

Pending...