Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (33 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.57 KB
Raw

Contributing to spcm

Thank you for your interest in contributing to spcm! We welcome contributions from the community to help make our project better.

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the repository and clone it to your local machine.
  2. Install the necessary dependencies.
  3. Create a new branch for your changes.
  4. Make your desired changes to the codebase.
  5. Test your changes to ensure they work as expected.
  6. Commit your changes and push them to your forked repository.
  7. Submit a pull request to the main repository.

Testing examples locally

After cloning the repository or a fork.

  1. Create and open a virtual environment 
    $ python -m venv venv
$ source venv/Scripts/activate
  2. Install the dependencies 
    (venv) $ pip install -r requirements

Code Style

We follow a specific code style in our project to maintain consistency. Please make sure to adhere to the following guidelines:

  • Use consistent indentation (e.g., 4 spaces or tabs).
  • Follow naming conventions for variables, functions, and classes.
  • Write clear and concise comments to explain your code.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on our issue tracker. Be sure to provide detailed information about the problem and steps to reproduce it.

Contact

If you have any questions or need further assistance, feel free to contact us at support@spec.de.

We appreciate your contributions and look forward to working with you!

Happy coding!