From 86efbf1bdcf53da302bb2ae3cdce281ddabdd18d Mon Sep 17 00:00:00 2001 From: Koichi Murase Date: Sun, 28 Apr 2024 17:34:54 +0900 Subject: [PATCH] docs(CONTRIBUTING): move a section and add minor fixes --- CONTRIBUTING.md | 68 +++++++++++++++++++++++++------------------------ 1 file changed, 35 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32949d7..040d585 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,10 +14,11 @@ you would make is not already covered. * [You have a suggestion](#you-have-a-suggestion) * [Pull Requests](#submitting-pull-requests) * [Getting started](#getting-started) - * [Copyright and responsibility](#copyright-and-responsibility) * [You have a solution](#you-have-a-solution) * [New Theme](#new-theme) * [New Plugin](#new-plugin) + * [Copyright and responsibility](#copyright-and-responsibility) + * [Improving PR](#improving-pr) * [Information sources (_aka_ search)](#use-the-search-luke) **BONUS:** [Volunteering](#you-have-spare-time-to-volunteer) @@ -41,7 +42,7 @@ It should include the data gathered as indicated above, along with: 2. What the correct behavior should be 3. What the actual behavior is -Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle +Please copy to anyone relevant (e.g. plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. We will do our very best to help you. @@ -56,7 +57,7 @@ If you find one, comment on it so we can know there are more people supporting i If not, you can go ahead and create an issue. Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. -## Submitting Pull Requests +## Submitting Pull Requests (PRs) The code should work with Bash 3.2. Make all the changes to be POSIX-compatible for external tools unless it is related to a plugin that @@ -71,7 +72,7 @@ change. - If you try to solve a [problem](#you-have-a-problem) and a solution to the problem is already reported, try it out and +1 the pull request if the - solution works ok. On the other hand, if you think your solution is better, + solution works OK. On the other hand, if you think your solution is better, post it with a reference to the other one so we can have both solutions to compare. - If you find an existing PR that is related, try it out and work with the @@ -84,9 +85,10 @@ You should be familiar with the basics of [contributing on GitHub](https://help.github.com/articles/using-pull-requests) and have a fork [properly set up](https://github.com/ohmybash/oh-my-bash/wiki/Contribution-Technical-Practices). -You MUST always create PRs with _a dedicated branch_ (i.e., a branch that is NOT `master`) based on the latest upstream tree. +You MUST always create a PR with _a dedicated branch_ (i.e., a branch that is +NOT `master`) based on the latest upstream tree. -The commit mesasge typically has the following form (with the first word in the +The commit message typically has the following form (with the first word in the verbal phrase being in the infinitive and capitalized): ``` @@ -103,44 +105,22 @@ The conventional commits are also accepted: ``` -When you open a new PR, please make sure you do it right. Also be so kind as to -reference any issues that would be solved in the PR description body, [for +When you open a new PR, please make sure you do it right. Also, reference in +the PR description body any issues that would be solved by the PR, [for instance](https://help.github.com/articles/closing-issues-via-commit-messages/) _"Fixes #XXXX"_ for issue number XXXX. -### Copyright and responsibility - -If you submit codes derived from other's work, please confirm that the license -is compatible with the MIT license. Please clarify which part is your own work -and which is not in the code and include **the copyright notice of the original -authors**. You may also include your own copyright notice, but we may omit -them because we can track them in the Git history. - -You can provide codes under any licenses which are compatible with the MIT -license. When you submit and update a PR (*NOT when the PR is merged*), unless -otherwise specified, **we assume that you provide the codes/texts under the MIT -license**. If you would like to provide the codes/texts with another license, -please specify it in the codes/texts. If you forgot to declare the license -that is not MIT, you can later declare it for the part you contributed. - -Do not submit AI-generated codes/documentation unless you understand both the -generated codes/documentation and the related **exiting codebase**. You are -required to be responsible for requests to the changes and reports of the -issues for the submitted codes/documentation. Also, please confirm that the -generated codes/texts can be included in Oh My Bash **with your own copyright -under the MIT license**. - ### You have a solution If you try to fix a problem or solve an issue in a specific plugin/theme/aliases, please also check the other modules if they have a -similar issue or can be improved in a similar way. In particular, @@@ +similar issue or can be improved in a similar way. ### New Theme A new theme is often created by modifying an existing theme. In that case, please clarify from which theme the new theme is derived from. If possible, it -is recommented to source the original theme file +is recommended to source the original theme file `"$OSH"/themes//.base.sh` or `"$OSH"/themes//.theme.sh` in the new theme file `"$OSH"/themes//.theme.sh` and include only the new parts in the new @@ -168,6 +148,28 @@ PR. When you add a new plugin, please also update [plugins/README.md](https://github.com/ohmybash/oh-my-bash/blob/master/plugins/README.md) +### Copyright and responsibility + +If you submit codes derived from other's work, please confirm that the license +is compatible with the MIT license. Please clarify which part is your own work +and which is not in the code and include **the copyright notice of the original +authors**. You may also include your own copyright notice, but we may omit +them because we can track them in the Git history. + +You can provide codes under any licenses which are compatible with the MIT +license. When you submit and update a PR (*NOT when the PR is merged*), unless +otherwise specified, **we assume that you provide the codes/texts under the MIT +license**. If you would like to provide the codes/texts with another license, +please specify it in the codes/texts. If you forgot to declare the license +that is not MIT, you can later declare it for the part you contributed. + +Do not submit AI-generated codes/documentation unless you understand both the +generated codes/documentation and the related **exiting codebase**. You are +required to be responsible for requests to the changes and reports of the +issues for the submitted codes/documentation. Also, please confirm that the +generated codes/texts can be included in Oh My Bash **with your own copyright +under the MIT license**. + ### Improving PR After opening PRs, you will usually receive requests for changes. It is rare @@ -177,7 +179,7 @@ further. If you become busy, please tell us that instead of ignoring our messages. You are expected to notify when you will be available again, hand over the PR to others, or to notify that you would discard the PR. -After the final version of the PR is settled, the fixup commits that fix +After the final version of the PR is settled, the fix-up commits that fix problems introduced in earlier commits in the same PR will be squashed. Also, the commits whose purposes heavily overlap will be squashed.