snegov/cura-te-ipsum
1
0 Fork 0
Code Issues 20 Releases Wiki Activity

Missing CONTRIBUTING.md and development documentation #23

New Issue
Open
opened 2025-11-15 03:44:22 +00:00 by snegov · 0 comments
snegov commented 2025-11-15 03:44:22 +00:00
Owner
Copy link
Copy source

Missing CONTRIBUTING.md and development documentation

Priority: Low
Component: Documentation
Type: Documentation

Description

The repository lacks documentation for contributors, making it harder for others to contribute to the project.

Missing Documentation

  1. CONTRIBUTING.md

    • How to set up development environment
    • How to run tests
    • Code style guidelines
    • How to submit pull requests
    • How to report bugs

  2. Development setup instructions

    • Installing development dependencies
    • Running tests locally
    • Running linters
    • Building documentation

  3. Architecture documentation

    • High-level design overview
    • How the backup process works internally
    • Why certain design decisions were made

Proposed Content

# Contributing to cura-te-ipsum

## Development Setup
git clone https://github.com/snegov/cura-te-ipsum.git
cd cura-te-ipsum
python -m venv venv
source venv/bin/activate
pip install -e .
pip install -r requirements-dev.txt

## Running Tests
pytest -v

## Code Style
- Follow PEP 8
- Use type hints
- Maximum line length: 88 characters (Black default)
- Add docstrings to all public functions

## Submitting Changes
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

Impact

Low - Improves contributor experience but doesn't affect functionality.

# Missing CONTRIBUTING.md and development documentation **Priority:** Low **Component:** Documentation **Type:** Documentation ## Description The repository lacks documentation for contributors, making it harder for others to contribute to the project. ## Missing Documentation 1. **CONTRIBUTING.md** - How to set up development environment - How to run tests - Code style guidelines - How to submit pull requests - How to report bugs 2. **Development setup instructions** - Installing development dependencies - Running tests locally - Running linters - Building documentation 3. **Architecture documentation** - High-level design overview - How the backup process works internally - Why certain design decisions were made ## Proposed Content ```markdown # Contributing to cura-te-ipsum ## Development Setup git clone https://github.com/snegov/cura-te-ipsum.git cd cura-te-ipsum python -m venv venv source venv/bin/activate pip install -e . pip install -r requirements-dev.txt ## Running Tests pytest -v ## Code Style - Follow PEP 8 - Use type hints - Maximum line length: 88 characters (Black default) - Add docstrings to all public functions ## Submitting Changes 1. Fork the repository 2. Create a feature branch 3. Make your changes 4. Add tests 5. Submit a pull request ``` ## Impact **Low** - Improves contributor experience but doesn't affect functionality.
Sign in to join this conversation.
No Branch/Tag Specified
Labels
No items
No labels
Milestone
No items
No Milestone
Assignees
Clear assignees
snegov (Maks Snegov)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: snegov/cura-te-ipsum#23