mirror of
https://github.com/FBukovina/Atoll.git
synced 2026-10-27 07:04: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
71
CODE_OF_CONDUCT.md
Normal file
71
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our community include:
|
||||
|
||||
- Demonstrating empathy and kindness toward other people
|
||||
- Being respectful of differing opinions, viewpoints, and experiences
|
||||
- Giving and gracefully accepting constructive feedback
|
||||
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
||||
- Focusing on what is best not just for us as individuals, but for the overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
- The use of sexualized language or imagery, and sexual attention or advances of any kind
|
||||
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others’ private information, such as a physical or email address, without their explicit permission
|
||||
- Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [maintainer email or Discord]. All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
**Community Impact**: A violation through a single incident or series of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
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