mirror of
https://github.com/FBukovina/Atoll.git
synced 2026-10-28 15:44:32 +00:00
Add CODE_OF_CONDUCT and CONTRIBUTING guidelines
This commit is contained in:
parent
1f04b6c9ce
commit
1f639cfc49
3 changed files with 160 additions and 0 deletions
89
CONTRIBUTING.md
Normal file
89
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
<p align="center">
|
||||
<img src=".github/assets/atoll-logo.png" alt="Atoll logo" width="100">
|
||||
</p>
|
||||
|
||||
# Contributing to Atoll
|
||||
|
||||
Thank you for your interest in contributing to Atoll! We welcome contributions from everyone—developers, designers, testers, and documentation writers. Please read the following guidelines to help us maintain a collaborative and high-quality project.
|
||||
|
||||
## Table of Contents
|
||||
- [How to Contribute](#how-to-contribute)
|
||||
- [Code of Conduct](#code-of-conduct)
|
||||
- [Development Setup](#development-setup)
|
||||
- [Pull Request Process](#pull-request-process)
|
||||
- [Coding Guidelines](#coding-guidelines)
|
||||
- [Design Contributions](#design-contributions)
|
||||
- [Documentation](#documentation)
|
||||
- [Community & Support](#community--support)
|
||||
|
||||
---
|
||||
|
||||
## How to Contribute
|
||||
|
||||
1. **Fork the repository** and clone your fork locally.
|
||||
2. **Create a feature branch** for your changes: `git switch -c feature/your-feature-name`
|
||||
3. **Make your changes** following the guidelines below.
|
||||
4. **Test your changes** to ensure they work as expected and do not break existing functionality.
|
||||
5. **Commit** with clear, descriptive messages.
|
||||
6. **Push** to your fork and submit a **pull request** (PR) to the `main` branch.
|
||||
7. **Participate in code review** and address any feedback.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
We are committed to fostering a welcoming and inclusive environment. Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before participating.
|
||||
|
||||
## Development Setup
|
||||
|
||||
- **Requirements:**
|
||||
- macOS Sonoma 14.0 or later
|
||||
- Xcode 15.0+ with Swift 5.9 toolchain
|
||||
- MacBook with a notch (for full feature testing)
|
||||
- **Clone the repo:**
|
||||
```bash
|
||||
git clone https://github.com/Ebullioscopic/Atoll.git
|
||||
cd Atoll
|
||||
open DynamicIsland.xcodeproj
|
||||
```
|
||||
- **Build & Run:**
|
||||
- Select your Mac as the run destination in Xcode.
|
||||
- Build and run (Cmd+R).
|
||||
- Grant any requested permissions.
|
||||
|
||||
## Pull Request Process
|
||||
|
||||
- Ensure your branch is up to date with `main` before submitting a PR.
|
||||
- Provide a clear description of your changes and the motivation behind them.
|
||||
- Reference any related issues or discussions.
|
||||
- Add screenshots or screen recordings for UI changes.
|
||||
- Ensure the code builds without errors or warnings.
|
||||
- Respond promptly to review feedback.
|
||||
|
||||
## Coding Guidelines
|
||||
|
||||
- Follow Swift API Design Guidelines.
|
||||
- Use meaningful variable and function names.
|
||||
- Keep functions focused and concise.
|
||||
- Add inline documentation for public APIs and complex logic.
|
||||
- Write unit tests for new features where practical.
|
||||
- Avoid introducing unnecessary dependencies.
|
||||
|
||||
## Design Contributions
|
||||
|
||||
- Submit UI/UX improvements, mockups, or visual assets.
|
||||
- Maintain consistency with macOS Human Interface Guidelines.
|
||||
- Provide rationale for design decisions.
|
||||
|
||||
## Documentation
|
||||
|
||||
- Improve user guides, API docs, and troubleshooting sections.
|
||||
- Translate documentation into other languages.
|
||||
- Clarify setup instructions and add usage examples.
|
||||
|
||||
## Community & Support
|
||||
|
||||
- Join our [Discord community](https://discord.gg/zvjB4tJBkt) for discussion, support, and collaboration.
|
||||
- Be respectful and constructive in all interactions.
|
||||
|
||||
---
|
||||
|
||||
Thank you for helping make Atoll better!
|
||||
Loading…
Add table
Add a link
Reference in a new issue