From e23927ffa2b23f22d474af1c2ba5c6ccf4196605 Mon Sep 17 00:00:00 2001 From: anyreso Date: Thu, 25 Apr 2024 00:02:10 -0400 Subject: [PATCH 1/7] =?UTF-8?q?=F0=9F=93=9D=20update=20CONTRIBUTING.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad35f9b..cfbca58 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,22 +14,37 @@ Include as much detail as possible, such as steps to reproduce the issue, expect ## 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. +When starting work on a new feature or bug fix, developers should always use the `develop` branch as their starting point. -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 contains the most recent and advanced codebase, as it serves as a staging area for upcoming features and fixes. -The `develop` branch serves as the staging area for upcoming features and fixes. - -When the `develop` branch is deemed stable and ready for release, it is merged into the `main` branch to create a new release. +Periodically, changes from `develop` are merged into the `main` branch to package releases. This practice ensures that everyone remains updated on ongoing tasks, fostering transparency and encouraging collaboration. +> All [merge requests (MR)][#create_merge_requests] must be merged into `develop` before any release is made on the `main` branch. + +```mermaid +flowchart LR + subgraph Alice's Fork + A[Feature Branch] --> C((Merge Request)) + end + subgraph Bob's Fork + B[Feature Branch] --> D((Merge Request)) + end + subgraph open-fpsz + C -->|To Target Branch| E[develop] + D -->|To Target Branch| E[develop] + E -->|Merge into\nOnce Stable & Ready| G[main] + end +``` + ## Fork-based workflow If you want to contribute changes without write access to the repository, you can still do so by forking. This is a simple way for anyone to contribute by creating your own copy of the project where you can make changes freely. 1. First, you'll need to fork the repository. -2. Once you have a fork, clone it to your local machine. +2. Once you have a fork, clone it to your local machine and create a new branch from the `develop` branch. 3. Then, you can make changes just like you would if you were a member of the project. 4. After you've made your changes, you commit them locally and push these back to your fork on gitlab. 5. Finally, you can [create a merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html#when-you-work-in-a-fork) from your fork's branch to upstream's branch. @@ -80,6 +95,8 @@ This naming convention helps to categorize branches and makes it easier to ident # Git Quick Reference +> 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. + 1. Create a new branch for your changes: ```shell From d3a2be631642d5d23b5302671695c07e14ca23c6 Mon Sep 17 00:00:00 2001 From: anyreso Date: Thu, 25 Apr 2024 00:04:09 -0400 Subject: [PATCH 2/7] =?UTF-8?q?=F0=9F=93=9D=20update=20CONTRIBUTING.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cfbca58..7c78424 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,15 +22,15 @@ Periodically, changes from `develop` are merged into the `main` branch to packag This practice ensures that everyone remains updated on ongoing tasks, fostering transparency and encouraging collaboration. -> All [merge requests (MR)][#create_merge_requests] must be merged into `develop` before any release is made on the `main` branch. +> Any [Merge Requests (MR)][#create_merge_requests] must be merged into `develop` before any release is made on the `main` branch. ```mermaid flowchart LR subgraph Alice's Fork - A[Feature Branch] --> C((Merge Request)) + A[feat/alice-branch] --> C((Merge Request)) end subgraph Bob's Fork - B[Feature Branch] --> D((Merge Request)) + B[feat/bob-branch] --> D((Merge Request)) end subgraph open-fpsz C -->|To Target Branch| E[develop] From cf0214a299cd508815aee84b77fdedfa5ca525b1 Mon Sep 17 00:00:00 2001 From: anyreso Date: Thu, 25 Apr 2024 00:19:41 -0400 Subject: [PATCH 3/7] =?UTF-8?q?=F0=9F=93=9D=20update=20CONTRIBUTING.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c78424..42ed3d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,9 @@ Periodically, changes from `develop` are merged into the `main` branch to packag This practice ensures that everyone remains updated on ongoing tasks, fostering transparency and encouraging collaboration. -> Any [Merge Requests (MR)][#create_merge_requests] must be merged into `develop` before any release is made on the `main` branch. +> Learn the various ways to [create a merge request][#create_merge_requests]. + +Here's a simplified diagram: ```mermaid flowchart LR From a8293b38694db739571fb734674ab96338301f19 Mon Sep 17 00:00:00 2001 From: anyreso Date: Thu, 25 Apr 2024 00:19:58 -0400 Subject: [PATCH 4/7] =?UTF-8?q?=F0=9F=93=9D=20update=20CONTRIBUTING.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 42ed3d4..1fb2fec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,8 +24,6 @@ This practice ensures that everyone remains updated on ongoing tasks, fostering > Learn the various ways to [create a merge request][#create_merge_requests]. -Here's a simplified diagram: - ```mermaid flowchart LR subgraph Alice's Fork From 078e2f479967cd12724a117c2ede1c68e597b932 Mon Sep 17 00:00:00 2001 From: anyreso Date: Thu, 25 Apr 2024 00:21:32 -0400 Subject: [PATCH 5/7] =?UTF-8?q?=F0=9F=93=9D=20update=20CONTRIBUTING.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fb2fec..4b46a70 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ Periodically, changes from `develop` are merged into the `main` branch to packag This practice ensures that everyone remains updated on ongoing tasks, fostering transparency and encouraging collaboration. -> Learn the various ways to [create a merge request][#create_merge_requests]. +> Learn how to [create a merge request][#create_merge_requests_from_fork] when you work in a fork. ```mermaid flowchart LR @@ -129,6 +129,7 @@ By following these guidelines, we aim to streamline our development process, mai Happy coding! 🎮✨ +[#create_merge_requests_from_fork]: https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html#when-you-work-in-a-fork [#create_merge_requests]: https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html [#issue_tracker]: https://gitlab.com/open-fpsz/open-fpsz/-/issues [#repo_url]:https://gitlab.com/open-fpsz/open-fpsz From e89224f56d85c99c48f642010cb1210200ac80cc Mon Sep 17 00:00:00 2001 From: anyreso Date: Thu, 25 Apr 2024 00:22:24 -0400 Subject: [PATCH 6/7] =?UTF-8?q?=F0=9F=93=9D=20update=20CONTRIBUTING.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b46a70..0923882 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ Periodically, changes from `develop` are merged into the `main` branch to packag This practice ensures that everyone remains updated on ongoing tasks, fostering transparency and encouraging collaboration. -> Learn how to [create a merge request][#create_merge_requests_from_fork] when you work in a fork. +> Learn how to [create a merge request][#create_merge_requests_from_fork] when working in a fork. ```mermaid flowchart LR From 8d8fd34a1bc95d5bf48e7ad005864fd6722a9f05 Mon Sep 17 00:00:00 2001 From: anyreso Date: Thu, 25 Apr 2024 00:30:05 -0400 Subject: [PATCH 7/7] =?UTF-8?q?=F0=9F=93=9D=20update=20CONTRIBUTING.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0923882..396c297 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ Periodically, changes from `develop` are merged into the `main` branch to packag This practice ensures that everyone remains updated on ongoing tasks, fostering transparency and encouraging collaboration. -> Learn how to [create a merge request][#create_merge_requests_from_fork] when working in a fork. +> Learn how to [create a merge request when you work in a fork][#create_merge_requests_from_fork]. ```mermaid flowchart LR