diff --git a/CHANGELOG.md b/CHANGELOG.md index 22ed7e0..d0a61c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] ### Changed -- Optimized GitLab CI cache configuration +- Optimized CI cache configuration - Removed temporary test scripts and improved .gitignore ## [1.0.0] - 2025-10-26 @@ -103,6 +103,6 @@ The initial release established the core framework with: --- -[Unreleased]: https://gitlab.com/your-repo/async_sdl_python/compare/v1.0.0...HEAD -[1.0.0]: https://gitlab.com/your-repo/async_sdl_python/compare/v0.0.1...v1.0.0 -[0.0.1]: https://gitlab.com/your-repo/async_sdl_python/releases/tag/v0.0.1 +[Unreleased]: https://github.com/shenning00/async_sdl_python/compare/v1.0.0...HEAD +[1.0.0]: https://github.com/shenning00/async_sdl_python/compare/v0.0.1...v1.0.0 +[0.0.1]: https://github.com/shenning00/async_sdl_python/releases/tag/v0.0.1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 23c584c..4ab511b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,11 +29,11 @@ We are committed to providing a welcoming and inclusive environment for all cont ### Setting Up Your Development Environment -1. Fork the repository on GitLab +1. Fork the repository on GitHub 2. Clone your fork: ```bash -git clone https://gitlab.com/YOUR_USERNAME/async_sdl_python.git +git clone https://github.com/YOUR_USERNAME/async_sdl_python.git cd async_sdl_python ``` @@ -121,7 +121,7 @@ pylint pysdl/ git push origin feature/amazing-feature ``` -Then create a Merge Request on GitLab with a clear description of your changes. +Then create a Pull Request on GitHub with a clear description of your changes. ## Development Guidelines @@ -482,9 +482,9 @@ Commit types: - `test:` - Adding tests - `chore:` - Maintenance tasks -### Merge Request Guidelines +### Pull Request Guidelines -When creating a merge request: +When creating a pull request: 1. **Title**: Clear, descriptive summary of changes 2. **Description**: Include: @@ -504,7 +504,7 @@ When creating a merge request: ### Review Process -After submitting a merge request: +After submitting a pull request: 1. Automated tests will run via CI/CD 2. Maintainers will review your code @@ -522,8 +522,8 @@ Tips for faster reviews: If you have questions or need help: - Check existing documentation in the `docs/` directory -- Review closed issues and merge requests for similar questions +- Review closed issues and pull requests for similar questions - Open a new issue for discussion -- Reach out to maintainers via GitLab +- Reach out to maintainers via GitHub Thank you for contributing to PySDL! diff --git a/README.md b/README.md index a89badf..02a9cf1 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ [![Python Version](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![Pipeline Status](https://gitlab.com/your-repo/async_sdl_python/badges/main/pipeline.svg)](https://gitlab.com/your-repo/async_sdl_python/-/commits/main) -[![Coverage](https://gitlab.com/your-repo/async_sdl_python/badges/main/coverage.svg)](https://gitlab.com/your-repo/async_sdl_python/-/commits/main) +[![CI](https://github.com/shenning00/async_sdl_python/actions/workflows/ci.yml/badge.svg)](https://github.com/shenning00/async_sdl_python/actions/workflows/ci.yml) +[![codecov](https://codecov.io/gh/shenning00/async_sdl_python/branch/main/graph/badge.svg)](https://codecov.io/gh/shenning00/async_sdl_python) A lightweight, asynchronous Python library implementing the **Specification and Description Language (SDL)** actor model pattern for building concurrent, event-driven applications. @@ -34,7 +34,7 @@ pip install pysdl **From source**: ```bash -git clone https://gitlab.com/your-repo/async_sdl_python.git +git clone https://github.com/shenning00/async_sdl_python.git cd async_sdl_python # Upgrade pip first to avoid installation issues python -m pip install --upgrade pip @@ -245,20 +245,10 @@ This project is licensed under the MIT License - see the LICENSE file for detail ## Support -- **Issues**: Report bugs via GitLab Issues +- **Issues**: Report bugs via GitHub Issues - **Documentation**: See the [docs/](docs/) directory - **Examples**: See [examples/main.py](examples/main.py) and [docs/examples.md](docs/examples.md) -## Breaking Changes in v1.0.0 - -PySDL v1.0.0 introduces breaking changes to support instance-based systems. This enables running multiple independent SDL systems in the same process and eliminates global state. - -Key changes: -- `SdlSystem` is now instance-based - create instances with `system = SdlSystem()` -- `SdlProcess.create()` and `__init__()` now require `system` parameter -- All `SdlSystem.method()` static calls are now `system.method()` instance calls -- Processes access their system via `self._system` attribute - ## Roadmap Future enhancements under consideration: diff --git a/SECURITY.md b/SECURITY.md index 9e6b9ca..568c9d6 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -15,7 +15,7 @@ We take the security of PySDL seriously. If you believe you have found a securit ### Reporting Process -**Please do not report security vulnerabilities through public GitHub/GitLab issues.** +**Please do not report security vulnerabilities through public GitHub issues.** Instead, please report them via email to: - **Email**: shenning_00@yahoo.com @@ -87,7 +87,7 @@ When using PySDL in your applications: ## Security Updates Security updates will be released as patch versions and announced via: -- GitLab release notes +- GitHub release notes - CHANGELOG.md updates - Email notification to reporters diff --git a/docs/getting_started.md b/docs/getting_started.md index dd1a08b..72bed0c 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -38,7 +38,7 @@ Before you begin with PySDL, ensure you have: ```bash # Clone the repository -git clone https://gitlab.com/your-repo/async_sdl_python.git +git clone https://github.com/shenning00/async_sdl_python.git cd async_sdl_python # Install in editable mode diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 9d230a3..6316d41 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -952,7 +952,7 @@ If you're still stuck: 1. **Check logs**: Enable verbose logging 2. **Read docs**: [API Reference](api_reference.md), [Architecture](architecture.md) 3. **Review examples**: [Examples](examples.md) -4. **File an issue**: Report bugs on GitLab +4. **File an issue**: Report bugs on GitHub 5. **Ask questions**: Use project discussions or issues --- diff --git a/pyproject.toml b/pyproject.toml index 6767892..56ee64a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,10 +38,10 @@ dev = [ ] [project.urls] -Homepage = "https://gitlab.com/YOUR_USERNAME/async_sdl_python" -"Bug Tracker" = "https://gitlab.com/YOUR_USERNAME/async_sdl_python/-/issues" -Documentation = "https://gitlab.com/YOUR_USERNAME/async_sdl_python/-/tree/main/docs" -"Source Code" = "https://gitlab.com/YOUR_USERNAME/async_sdl_python" +Homepage = "https://github.com/shenning00/async_sdl_python" +"Bug Tracker" = "https://github.com/shenning00/async_sdl_python/issues" +Documentation = "https://github.com/shenning00/async_sdl_python/tree/main/docs" +"Source Code" = "https://github.com/shenning00/async_sdl_python" [tool.ruff] # Set line length to match Black's default