From 8e77465990880c7e584cc1ad3f2b976c772c7281 Mon Sep 17 00:00:00 2001 From: SahWag <65761770+SahWag@users.noreply.github.com> Date: Tue, 5 Sep 2023 16:59:34 +0200 Subject: [PATCH 1/4] Create open_source_commits.rst --- docs/guidelines/open_source_commits.rst | 27 +++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/guidelines/open_source_commits.rst diff --git a/docs/guidelines/open_source_commits.rst b/docs/guidelines/open_source_commits.rst new file mode 100644 index 000000000..22d7f0d77 --- /dev/null +++ b/docs/guidelines/open_source_commits.rst @@ -0,0 +1,27 @@ +======================= +Guidelines on contributing to open-source projects +======================= +.. _guidelines-development: + +This documents proposes development guidelines on how to make contributions to open-source projects in a structured manner. + +**NOTE**: All the proposal here are the results of authors' personal experiences. Saying that, if you have any idea to make them better you are very welcome to create a PR. + +Steps to follow +========= + +1. Try and fix the changes locally in your own fork + +2. Commit and push to your own feature branch + +3. Go to the upstream branch(of the main project, not just the fork) + +4. Create a new feature branch from the upstream branch + +5. Apply your changes(using cherry-pick) using your own commit hash + +6. Push to your own repository branch + +7 Open a pull request on the upstream repository + +**WORK-IN-PROGRESS, MORE CONTENT AND MORE IMPROVEMENTS TO BE ADDED SOON** From 2dea9bee138748a8463e803b1d5fdd086b92d421 Mon Sep 17 00:00:00 2001 From: SahWag <65761770+SahWag@users.noreply.github.com> Date: Wed, 6 Sep 2023 09:49:17 +0200 Subject: [PATCH 2/4] Update open_source_commits.rst --- docs/guidelines/open_source_commits.rst | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/guidelines/open_source_commits.rst b/docs/guidelines/open_source_commits.rst index 22d7f0d77..0ae53e94f 100644 --- a/docs/guidelines/open_source_commits.rst +++ b/docs/guidelines/open_source_commits.rst @@ -3,25 +3,17 @@ Guidelines on contributing to open-source projects ======================= .. _guidelines-development: -This documents proposes development guidelines on how to make contributions to open-source projects in a structured manner. +This documents proposes development guidelines on how to make contributions to open-source projects in a structured manner. When you find a new issue or want to solve an existing issue in an open source project, you can perform the following steps to increase the chances of making your contribution useful and appreciated. **NOTE**: All the proposal here are the results of authors' personal experiences. Saying that, if you have any idea to make them better you are very welcome to create a PR. -Steps to follow -========= +#. First, try and fix the changes locally in your own branch. Usually, you do this in a repository which is forked from the main open-source project. -1. Try and fix the changes locally in your own fork +#. Once you've found a good solution, commit and push to your own feature branch. Be aware that you only fix the relevant issue in this feature branch, don't make more changes than is necessary. -2. Commit and push to your own feature branch +#. Go to the upstream branch of your forked repository, and create a new feature branch. -3. Go to the upstream branch(of the main project, not just the fork) +#. In this feature branch, apply the changes you made in your previous branch with its commit hash(using cherry-pick) and push it. -4. Create a new feature branch from the upstream branch +#. Open a pull request on the upstream branch of the main repository for your feature branch. Make sure you adhere to the project's guidelines on how to write the pull request. -5. Apply your changes(using cherry-pick) using your own commit hash - -6. Push to your own repository branch - -7 Open a pull request on the upstream repository - -**WORK-IN-PROGRESS, MORE CONTENT AND MORE IMPROVEMENTS TO BE ADDED SOON** From 385d2f387b896fccc4893dab71e355bdbff7d923 Mon Sep 17 00:00:00 2001 From: SahWag <65761770+SahWag@users.noreply.github.com> Date: Wed, 6 Sep 2023 10:08:38 +0200 Subject: [PATCH 3/4] Fix doc8 linter errors --- docs/guidelines/open_source_commits.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/guidelines/open_source_commits.rst b/docs/guidelines/open_source_commits.rst index 0ae53e94f..cd38a2381 100644 --- a/docs/guidelines/open_source_commits.rst +++ b/docs/guidelines/open_source_commits.rst @@ -1,6 +1,6 @@ -======================= +=================================================== Guidelines on contributing to open-source projects -======================= +=================================================== .. _guidelines-development: This documents proposes development guidelines on how to make contributions to open-source projects in a structured manner. When you find a new issue or want to solve an existing issue in an open source project, you can perform the following steps to increase the chances of making your contribution useful and appreciated. @@ -16,4 +16,3 @@ This documents proposes development guidelines on how to make contributions to o #. In this feature branch, apply the changes you made in your previous branch with its commit hash(using cherry-pick) and push it. #. Open a pull request on the upstream branch of the main repository for your feature branch. Make sure you adhere to the project's guidelines on how to write the pull request. - From ab94a0ead977fe2ea6a2a416cf1a8697b7657018 Mon Sep 17 00:00:00 2001 From: SahWag <65761770+SahWag@users.noreply.github.com> Date: Wed, 6 Sep 2023 10:11:15 +0200 Subject: [PATCH 4/4] Fix trailing whitespace --- docs/guidelines/open_source_commits.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guidelines/open_source_commits.rst b/docs/guidelines/open_source_commits.rst index cd38a2381..0944beef5 100644 --- a/docs/guidelines/open_source_commits.rst +++ b/docs/guidelines/open_source_commits.rst @@ -11,7 +11,7 @@ This documents proposes development guidelines on how to make contributions to o #. Once you've found a good solution, commit and push to your own feature branch. Be aware that you only fix the relevant issue in this feature branch, don't make more changes than is necessary. -#. Go to the upstream branch of your forked repository, and create a new feature branch. +#. Go to the upstream branch of your forked repository, and create a new feature branch. #. In this feature branch, apply the changes you made in your previous branch with its commit hash(using cherry-pick) and push it.