Develop

Contributing to pySLAMMER

Thank you for your interest in contributing to pySLAMMER! We welcome contributions from the community to improve and expand the package.

Getting Started

1. Clone the Repository:

   git clone https://github.com/lornearnold/pyslammer.git
   cd pyslammer

2. Install Dependencies: Ensure you have Python installed (preferably version 3.8 or higher). Install the required dependencies:

   pip install -r requirements.txt

3. Set Up a Development Environment: Optionally, create a virtual environment to isolate your development setup:

   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

Development Workflow

1. Create a New Branch: Always create a new branch for your changes:

   git checkout -b feature/your-feature-name

2. Follow Coding Standards:

   • Write clean, readable, and well-documented code.
   • Follow PEP 8 guidelines for Python code.

3. Add Tests: Ensure your changes are covered by tests. Add new tests in the tests/ directory if necessary.

Warning

The base tests for pySLAMMER are still being developed.

Testing

Run the test suite to ensure everything works as expected:

pytest tests/

Submitting Changes

1. Commit Your Changes: Write clear and concise commit messages:

   git add .
   git commit -m "Add a brief description of your changes"

2. Push Your Branch:

   git push origin feature/your-feature-name

3. Create a Pull Request: Go to the GitHub repository and create a pull request. Provide a detailed description of your changes.

Contribution Guidelines

• Be respectful and collaborative.
• Ensure your code passes all tests and adheres to the coding standards.
• Provide clear documentation for any new features or changes.

Thank you for contributing to pySLAMMER!