openfpsz/open-fpsz
1
0
Fork 0
mirror of https://gitlab.com/open-fpsz/open-fpsz.git synced 2026-04-25 14:25:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

📝 update CONTRIBUTING.md

Browse source
This commit is contained in:
anyreso 2024-04-13 15:23:04 -04:00
parent ee3fe53ecd
commit 1ce991c7b6
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -8,13 +8,13 @@ Whether you're an experienced developer or just starting out, we welcome your co
## Reporting Issues
If you encounter any bugs or issues, please report them in the [Issue Tracker](#issue_tracker). Include as much detail as possible, such as steps to reproduce the issue and expected vs. actual behavior.
If you encounter any bugs or issues, please report them in the [Issue Tracker][#issue_tracker]. Include as much detail as possible, such as steps to reproduce the issue and expected vs. actual behavior.
## Merge Requests and Releases
We highly recommend using [gitmoji](https://gitmoji.dev) for expressive and visually appealing commit messages, as it provides an easy way of identifying the purpose or intention of a commit simply by looking at the emojis used.
Every [merge request (MR)](#create_merge_requests) must be merged into the `develop` branch before any release is made on the `main` branch.
Every [merge request (MR)][#create_merge_requests] must be merged into the `develop` branch before any release is made on the `main` branch.
The `develop` branch serves as the staging area for upcoming features and fixes.
@ -42,13 +42,13 @@ When your branch is merged, you may want to [update your fork](https://docs.gitl
## Repository membership
Access to our [gitlab repository](#repo_url) is essential for collaborative development and ensuring the integrity of our project. If you're interested in contributing to our codebase or becoming a member, please follow these guidelines:
Access to our [gitlab repository][#repo_url] is essential for collaborative development and ensuring the integrity of our project. If you're interested in contributing to our codebase or becoming a member, please follow these guidelines:
1. **Contribution**: Get involved in the project by contributing code, reporting issues, or participating in discussions on our [discord](https://discord.gg/tdmV3MxCn5) or [gitlab repository](#repo_url).
1. **Contribution**: Get involved in the project by contributing code, reporting issues, or participating in discussions on our [discord](https://discord.gg/tdmV3MxCn5) or [gitlab repository][#repo_url].
2. **Familiarization**: Read about development guidelines, coding style, conventions. Understanding these aspects will help you make meaningful contributions to our codebase.
3. **Request**: Upon a single merge request merged in `develop`, anyone can request to become a member, reach out to other members for access.
4. **Review**: We will assess factors such as the quality of your contributions, adherence to our guidelines and alignment with our project's vision.
5. **Access**: Upon approval, a membership will be granted to our [gitlab repository](#repo_url), allowing you to directly contribute, review changes and collaborate with others.
5. **Access**: Upon approval, a membership will be granted to our [gitlab repository][#repo_url], allowing you to directly contribute, review changes and collaborate with others.
Please note that while we welcome contributions from everyone, access to our repository is granted at our discretion.
@ -98,7 +98,7 @@ git commit -am "📝 update CONTRIBUTIONS.md"
git push
```
4. Create a [merge request (MR)](#create_merge_requests) with a clear description of your changes
4. Create a [merge request (MR)][#create_merge_requests] with a clear description of your changes
## Excluding local files without creating a _.gitignore_ file