starred/Memola
1
0
Fork 0
mirror of https://github.com/dscyrescotti/Memola.git synced 2026-04-25 10:08:34 +02:00
Code Issues 5 Packages Projects Releases 3 Wiki Activity

docs: update contributing guideline

Browse Source
This commit is contained in:
dscyrescotti
2024-11-28 22:12:51 +07:00
parent 9cf4e6ac10
commit 8c799b7973
1 changed files with 22 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@@ -2,13 +2,23 @@
Be a part of Memola! Pull requests, bug reports, suggestions and any other contributions are welcomed and highly encouraged. Be a part of Memola! Pull requests, bug reports, suggestions and any other contributions are welcomed and highly encouraged.
## Fork and Clone ## Table of Contents
- [Getting Start](#getting-started)
- [Contributing](#contributing)
- [Branching](#branching)
- [Pull Request](#pull-request)
- [Feature Request](#feature-request)
- [Bug Report](#bug-report)
- [Community](#community)
- [Code of Conduct](#code-of-conduct)
## Getting Started
Tap the "Fork" button on the top of the site. After forking, clone the forked repository to your Mac. Tap the "Fork" button on the top of the site. After forking, clone the forked repository to your Mac.
```bash ```bash
git clone https://github.com/dscyrescotti/Memola.git git clone https://github.com/dscyrescotti/Memola.git
cd Memola cd Memola
``` ```
## Run Project
Make sure you have already installed the latest Xcode and open the project. Make sure you have already installed the latest Xcode and open the project.
```bash ```bash
xed Memola.xcodeproj xed Memola.xcodeproj
@@ -16,7 +26,7 @@ xed Memola.xcodeproj
Now you are good to run the project and explore the codebase. Now you are good to run the project and explore the codebase.
> [!IMPORTANT] > [!IMPORTANT]
> You need to change the bundle identifier and run the project on a real device that supports for Metal. > You need to change the bundle identifier and run the project on a real device that supports for Metal.
> You can check Metal compatibility [here](https://support.apple.com/en-us/102894) > You can check Metal compatibility [here](https://support.apple.com/en-us/102894).
## Contributing ## Contributing
We’re excited to have you contribute and be part of our project’s growth! Whether you’re fixing bugs, implementing new features, or suggesting improvements, your input is invaluable. We’re excited to have you contribute and be part of our project’s growth! Whether you’re fixing bugs, implementing new features, or suggesting improvements, your input is invaluable.
@@ -24,8 +34,16 @@ We’re excited to have you contribute and be part of our project’s growth! Wh
- Our list of open bug issues is a great way to contribute and improve the app’s stability. Browse the "Issues" tab to find bugs labeled as “bug” or “help wanted”. - Our list of open bug issues is a great way to contribute and improve the app’s stability. Browse the "Issues" tab to find bugs labeled as “bug” or “help wanted”.
- Feel free to bring your own commits for enhancements—whether it’s a new feature, optimization, or improvement, your input matters! - Feel free to bring your own commits for enhancements—whether it’s a new feature, optimization, or improvement, your input matters!
## Branching
When contributing to Memola, please follow these branching guidelines to ensure smooth collaboration:
- Always create your branches starting from the `develop` branch.
- Use a clear and descriptive name that reflects the purpose of the branch, such as:
- `feature/your-feature-name` for new features.
- `bug/issue-description` for bug fixes.
## Pull Request ## Pull Request
Once you are happy with your changes, submit a "Pull Request". Once you are happy with your changes, submit a "Pull Request" targeting the `develop` branch for review.
The pull request opens with a template loaded. Fill out all fields that are relevant. The pull request opens with a template loaded. Fill out all fields that are relevant.