From a4b1f3a18828ea55fe3a724d192691e3d024c22a Mon Sep 17 00:00:00 2001 From: Alexander Molchevsky Date: Wed, 26 Apr 2023 17:54:46 +0300 Subject: [PATCH] Added the initial description --- process/how_to_suggest_new_changes.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 process/how_to_suggest_new_changes.md diff --git a/process/how_to_suggest_new_changes.md b/process/how_to_suggest_new_changes.md new file mode 100644 index 0000000..44745f0 --- /dev/null +++ b/process/how_to_suggest_new_changes.md @@ -0,0 +1,26 @@ +## How to Suggest New Code, Documentation, or Other Development Artifacts + +#### Context: + +Our project management system is driven by issues, which means that it tracks tasks through issues rather than pull requests. To propose a new activity, such as reporting a bug or making changes to the repository, you need to create an issue with a detailed description of what changes you want to make and why they are important. The issue will be discussed at a developer meeting, and if it is deemed necessary, it will be added to a sprint, and a developer will be assigned to work on it. + +However, there are cases when you have already made changes to the code or documentation that address the issue you want to create. For example, you may have conducted initiative research, tested your ideas, experimented with the code, made many modifications, and then found a significant improvement that makes the project much faster. Alternatively, while working on another task, you may have discovered and fixed a bug. In these cases, you already have a set of modifications that you want to suggest adding to the repository. +Simply creating an issue and waiting for it to be added to a sprint and assigned to you is not a good approach. You want to save your changes somewhere and demonstrate your solution to the team when they will discuss the issue. It would be good to save enough information with the issue to allow another person to resolve this issue if needed. You already have a solution and you want to save it with your issue. In this case, another assignee could use your changes, and other developers could see them and discuss your solution. + +#### The Procedure: + +1. Create an issue with a comprehensive description of the changes or additions you want to propose for the repository. + +2. Create a draft pull request with the changes you want to propose. + +3. Link the issue with the draft pull request. + +4. Wait for the developers to discuss the issue at a meeting. If they decide that the issue should be processed, it will be added to a sprint, and a developer will be assigned to work on it. + +5. After the assignee completes the task and the linked pull request, they should switch the pull request from draft to an active state and request a review. + +6. Once the pull request has been reviewed, the assignee should merge it to the repository. + +7. After the merge, the pull request and the linked issue will be automatically closed. + +