From 5f8debb28476774303755070a945cef777a95c7d Mon Sep 17 00:00:00 2001 From: Hariharan Mudaliar Date: Tue, 28 Oct 2025 12:50:41 +0530 Subject: [PATCH] Update README and Contributing --- CONTRIBUTING.md | 8 +++++++ ReadMe.md | 55 ++++--------------------------------------------- 2 files changed, 12 insertions(+), 51 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fa7635..05e6feb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,8 +14,10 @@ Thank you for your interest in contributing to Atoll! We welcome contributions f - [Coding Guidelines](#coding-guidelines) - [Design Contributions](#design-contributions) - [Documentation](#documentation) +- [Code Review process](#code-review-process) - [Community & Support](#community--support) + --- ## How to Contribute @@ -79,6 +81,12 @@ We are committed to fostering a welcoming and inclusive environment. Please read - Translate documentation into other languages. - Clarify setup instructions and add usage examples. +## Code review process +- All pull requests require review from project maintainers before merging. +- Automated testing must pass via continuous integration workflows. +- Changes should not significantly decrease test coverage without justification. +- Breaking changes require major version updates following semantic versioning. + ## Community & Support - Join our [Discord community](https://discord.gg/zvjB4tJBkt) for discussion, support, and collaboration. diff --git a/ReadMe.md b/ReadMe.md index 7651925..50bba7c 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -294,57 +294,6 @@ This operation clears UserDefaults, removes application support files and caches - Search Console.app for process name "DynamicIsland" to filter relevant log entries. - Report persistent issues with Console logs attached at the project's GitHub Issues page. -## Contributing - -Contributions are welcome from developers, designers, and documentation writers. Follow these guidelines to ensure smooth collaboration: - -### For developers -1. **Fork the repository** and clone your fork locally: - ```bash - git clone https://github.com/your-username/Atoll.git - cd Atoll - ``` -2. **Create a feature branch** from main with a descriptive name: - ```bash - git switch -c feature/your-feature-name - ``` -3. **Follow existing architecture**: Maintain the SwiftUI structure, leverage Combine for reactive data flow, and avoid introducing unnecessary dependencies. -4. **Code style**: Follow Swift API Design Guidelines, use meaningful variable names, and keep functions focused on single responsibilities. -5. **Testing**: Add unit tests for new functionality where practical, particularly for data models and utility functions. -6. **Documentation**: Update inline documentation for public APIs and add explanatory comments for complex logic. -7. **Commit changes** with clear, concise commit messages: - ```bash - git add . - git commit -m "Add feature: brief description of changes" - ``` -8. **Push to your fork** and submit a pull request: - ```bash - git push origin feature/your-feature-name - ``` - -### Pull request guidelines -- Provide a clear description of the changes, motivation, and any related issues. -- Include testing notes explaining how to verify the changes. -- Attach screenshots or screen recordings for UI changes. -- Ensure the code builds without errors or warnings. -- Respond to review feedback promptly and update the PR as needed. - -### For designers -- Contribute UI/UX improvements, mockups, and design refinements. -- Submit icon designs, animation concepts, or visual asset enhancements. -- Provide design rationale and maintain consistency with macOS Human Interface Guidelines. - -### For documentation -- Improve user guides, API documentation, and troubleshooting sections. -- Translate documentation into additional languages. -- Clarify setup instructions and add missing usage examples. - -### Code review process -- All pull requests require review from project maintainers before merging. -- Automated testing must pass via continuous integration workflows. -- Changes should not significantly decrease test coverage without justification. -- Breaking changes require major version updates following semantic versioning. - ## License Atoll is released under the GPL v3 License. Refer to [LICENSE](LICENSE) for the full terms. @@ -358,7 +307,11 @@ Atoll builds upon the work of several open-source projects and draws inspiration - [**Stats**](https://github.com/exelban/stats) - source implementation for CPU temperature monitoring via SMC (System Management Controller) access, frequency sampling through IOReport bindings, and per-core CPU utilisation tracking. The system metrics collection architecture derives from Stats project readers. +## Contributors + + + ## Updating Existing Clones If you previously cloned DynamicIsland, update the remote to track the Atoll repository: