diff --git a/source/fusiondirectory/development/howtodev/how-to.rst b/source/fusiondirectory/development/howtodev/how-to.rst index 6b3b2ccea13bcd30cc9b46dc1389688506743d77..87690f3c3076da6514d775efb0f1b485fb6e8a06 100644 --- a/source/fusiondirectory/development/howtodev/how-to.rst +++ b/source/fusiondirectory/development/howtodev/how-to.rst @@ -100,25 +100,45 @@ Once the branch is created, you can start development. 5. Create an Issue on the Origin Project ---------------------------------------- -Once you have completed your development and your merge request is ready, you need to create an issue on the original project. +Once you have completed your development and your Merge Request (MR) is ready, you must create an issue on the original project. +This issue will help FusionDirectory developers review your contribution and track its integration into the main codebase. -1. Navigate to the **Issues** section of the original project: +### Steps to Create an Issue +1. **Navigate to the Issues Section** - In the project repository, click **Issues** in the left sidebar. - Click the **New Issue** button. -2. Fill in the issue details: + .. image:: images/NewIssueContribution.png +2. **Fill in the Issue Details** - **Title**: Provide a concise and clear summary of the issue. - - **Description**: Explain the issue or feature request in detail, including expected behavior. - - **Template**: Use the available issue template and ensure all sections are completed correctly. + - **Description**: Explain the feature request or bug fix in detail, including expected behavior. + - **Template**: Use the appropriate issue template (e.g., **Contribution**), ensuring all sections are properly completed. -3. In the **Description**, make sure to link your Merge Request from your personal fork. -This allows the FusionDirectory developers to review your code and integrate it into the original codebase. +3. **Link Your Merge Request** + - In the **Description**, include a direct link to your Merge Request from your personal fork. + - This allows FusionDirectory developers to easily access and review your changes. -4. Click **Submit Issue** to create it. +4. **Assign a FusionDirectory Team Member** + - Assign a FusionDirectory developer to review your issue and code. + - This ensures your contribution is processed efficiently. + + .. image:: images/NewIssueContribution2.png + +5. **Submit the Issue** + - Click **Submit Issue** to create it. + +6. **Verify the Linked Merge Request** + - After submitting the issue, check if your Merge Request is automatically listed in the **Linked Items** section. + - If it is not linked, manually add a reference to your MR in this section. + + .. image:: images/NewIssueContribution3.png --- -That's it! -We look forward to your contributions and innovations! +**That's it!** + +Once a FusionDirectory team member receives a notification of your contribution, they will review your code and discuss any necessary changes using GitLab's comment section below your open issue. + +We look forward to your contributions and innovations! \ No newline at end of file diff --git a/source/fusiondirectory/development/howtodev/images/NewIssueContribution.png b/source/fusiondirectory/development/howtodev/images/NewIssueContribution.png new file mode 100644 index 0000000000000000000000000000000000000000..91c3f971f72f7d617c38e3593a871217a8a572b6 Binary files /dev/null and b/source/fusiondirectory/development/howtodev/images/NewIssueContribution.png differ diff --git a/source/fusiondirectory/development/howtodev/images/NewIssueContribution2.png b/source/fusiondirectory/development/howtodev/images/NewIssueContribution2.png new file mode 100644 index 0000000000000000000000000000000000000000..0a0b4add53ffe5e217dbd1e2b8fb312519fb2295 Binary files /dev/null and b/source/fusiondirectory/development/howtodev/images/NewIssueContribution2.png differ diff --git a/source/fusiondirectory/development/howtodev/images/NewIssueContribution3.png b/source/fusiondirectory/development/howtodev/images/NewIssueContribution3.png new file mode 100644 index 0000000000000000000000000000000000000000..89540fbc1c1ed6ec433744a07e4aa9b7d75ea85d Binary files /dev/null and b/source/fusiondirectory/development/howtodev/images/NewIssueContribution3.png differ diff --git a/source/fusiondirectory/development/howtodev/index.rst b/source/fusiondirectory/development/howtodev/index.rst index cda7c4b5c0c7fb4302223c748ea13451f60e60ec..c047ac6cf37f3518f840599e121b59d57cae4147 100644 --- a/source/fusiondirectory/development/howtodev/index.rst +++ b/source/fusiondirectory/development/howtodev/index.rst @@ -4,4 +4,4 @@ Start developing .. toctree:: :maxdepth: 2 - howtodev/how-to.rst + how-to.rst diff --git a/source/fusiondirectory/development/index.rst b/source/fusiondirectory/development/index.rst index 8239d88502265891f85fd87e34cf0f128a5b2f49..410246d040350d8a4fdd9ef11eb3a48392b10dc6 100644 --- a/source/fusiondirectory/development/index.rst +++ b/source/fusiondirectory/development/index.rst @@ -6,7 +6,7 @@ Development contribute/guidelines.rst - howtodev/how-to.rst + howtodev/index.rst codingstyle/index.rst writeplugin/index.rst api/index.rst