From cc8449c34f8021d6fb25a70f033087d960a70363 Mon Sep 17 00:00:00 2001 From: Martijn Swinkels Date: Mon, 17 Dec 2018 12:44:56 +0100 Subject: [PATCH 1/7] Add basic version of Contribution guidelines, issue template, and PR template --- .github/CONTRIBUTING.md | 94 ++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 17 ++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 +++++ 3 files changed, 126 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..8d35e42fba --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,94 @@ +# Contributing to TAO + +When contributing to the TAO project, please first discuss the change you wish to make via issue. + +Contributions to the TAO codebase are done using the fork & pull model. +This contribution model has contributors maintaining their own copy of the forked codebase (which can easily be synced with the main copy). The forked repository is then used to submit a request to the base repository to “pull” a set of changes. For more information on pull requests please refer to [GitHub Help](https://help.github.com/articles/about-pull-requests/). + +The TAO development team will review all issues and contributions submitted by the community of developers in the first in, first out order. During the review we might require clarifications from the contributor. If there is no response from the contributor within two weeks, the pull request will be closed. + +## Contribution process + +If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free). This will allow you to collaborate with the TAO development team, fork the TAO project and send pull requests. + +1. Check the open an closed issues for similar proposals of intended contribution before starting work on a new contribution. +2. Create and test your work. +3. Fork the TAO repository. +4. Create a branch that follows the [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) branching model. +5. Once development has been done, create a pull request that targets the development branch. +6. Once your contribution is received the TAO development team will review the contribution and collaborate with you as needed. + +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [community@taotesting.com](mailto:community@taotesting.com). All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4/][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..d8976c5abb --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,17 @@ +### Subject of the issue +Describe your issue here. + +### Your environment +* Which browser and version are you using? +* Which PHP version are you using? +* Which Database engine and version are you using? +* Which Web server are you using? + +### Steps to reproduce +Tell us how to reproduce this issue. + +### Expected behaviour +Tell us what should happen + +### Actual behaviour +Tell us what happens instead \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..567b7e4ebf --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +Before you submit a pull request, please make sure you have to following: + +- [ ] The subject of this pull request contains an (internal) issue number. +- [ ] Your branch follows the [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) branching model. +- [ ] A new unit test has been created, or the existing test has been updated. +- [ ] All new and existing tests passed. + +Describe the changes you made in your pull request here + +### Testing this PR +Please provide a description of how to test the changes made in this pull request. + +### Actual behaviour +Tell us what happens instead + From ef2478f210d59dfa00f1da9bede970a152d242ad Mon Sep 17 00:00:00 2001 From: Martijn Swinkels Date: Mon, 17 Dec 2018 14:11:24 +0100 Subject: [PATCH 2/7] Updated PR guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 567b7e4ebf..7ba23bc895 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,18 @@ -Before you submit a pull request, please make sure you have to following: +_Before you submit a pull request, please make sure you have to following:_ -- [ ] The subject of this pull request contains an (internal) issue number. +- [ ] The title of this pull request offers a good description of what is changed (as it is used in release notes). - [ ] Your branch follows the [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) branching model. +- [ ] The code follows the [best practices](#). +- [ ] The functionality has been manually tested (if applicable) - [ ] A new unit test has been created, or the existing test has been updated. - [ ] All new and existing tests passed. +- [ ] The module version has been bumped. + +--- Describe the changes you made in your pull request here -### Testing this PR -Please provide a description of how to test the changes made in this pull request. +**Testing the changes** -### Actual behaviour -Tell us what happens instead +Please provide a description of how to test the changes made in this pull request. From 28782d57dca96e5ecc29851c6164b15ecf04dd96 Mon Sep 17 00:00:00 2001 From: Martijn Swinkels Date: Fri, 22 Mar 2019 10:09:12 +0100 Subject: [PATCH 3/7] Updated guidelines --- .github/CONTRIBUTING.md | 4 ++-- .github/PULL_REQUEST_TEMPLATE.md | 12 +++++++++--- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8d35e42fba..6a13330862 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -13,9 +13,9 @@ If you are a new GitHub user, we recommend that you create your own [free github 1. Check the open an closed issues for similar proposals of intended contribution before starting work on a new contribution. 2. Create and test your work. -3. Fork the TAO repository. +3. Fork the repository of the TAO extension you wish to contribute to. 4. Create a branch that follows the [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) branching model. -5. Once development has been done, create a pull request that targets the development branch. +5. Once development has been done, create a pull request that targets the development branch of the extension you are contributing to. 6. Once your contribution is received the TAO development team will review the contribution and collaborate with you as needed. ## Code of Conduct diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7ba23bc895..9af7a19aff 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,12 +2,18 @@ _Before you submit a pull request, please make sure you have to following:_ - [ ] The title of this pull request offers a good description of what is changed (as it is used in release notes). - [ ] Your branch follows the [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) branching model. -- [ ] The code follows the [best practices](#). -- [ ] The functionality has been manually tested (if applicable) +- [ ] The code follows the [best practices (to be defined)](#). +- [ ] The functionality has been manually tested (if applicable). +- [ ] The update script has been run, and causes no issues. +- [ ] The functionality has been tested after a clean install. - [ ] A new unit test has been created, or the existing test has been updated. - [ ] All new and existing tests passed. -- [ ] The module version has been bumped. +- [ ] The module version has been bumped in both the manifest.php, and Updater.php files. +--- +**Depends on** +- [ ] List other pull requests that depend on this pull request +- [ ] Also list pull requests that require this pull request --- Describe the changes you made in your pull request here From 73c2f3ad72b075ce4196720b5b72f51fed0f67a1 Mon Sep 17 00:00:00 2001 From: Martijn Swinkels Date: Fri, 22 Mar 2019 10:14:07 +0100 Subject: [PATCH 4/7] Updated contribution guidelines and issue template --- .github/CONTRIBUTING.md | 3 ++- .github/ISSUE_TEMPLATE.md | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 6a13330862..9392de90f9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,7 +16,8 @@ If you are a new GitHub user, we recommend that you create your own [free github 3. Fork the repository of the TAO extension you wish to contribute to. 4. Create a branch that follows the [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) branching model. 5. Once development has been done, create a pull request that targets the development branch of the extension you are contributing to. -6. Once your contribution is received the TAO development team will review the contribution and collaborate with you as needed. +6. If your code depends on changes in another extension, create a draft pull request, until all required pull requests are created. +7. Once your contribution is received the TAO development team will review the contribution and collaborate with you as needed. ## Code of Conduct diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d8976c5abb..89d278a616 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -6,6 +6,7 @@ Describe your issue here. * Which PHP version are you using? * Which Database engine and version are you using? * Which Web server are you using? +* Which extensions are installed, and what version are they? ### Steps to reproduce Tell us how to reproduce this issue. From 7b789b2ab309f4f61d5b8ee7daeab66fb7e8980d Mon Sep 17 00:00:00 2001 From: andsnunes <48943766+andsnunes@users.noreply.github.com> Date: Thu, 4 Apr 2019 14:55:14 +0200 Subject: [PATCH 5/7] Small wording adjustments --- .github/CONTRIBUTING.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 9392de90f9..ccd97256b3 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,20 +2,20 @@ When contributing to the TAO project, please first discuss the change you wish to make via issue. -Contributions to the TAO codebase are done using the fork & pull model. -This contribution model has contributors maintaining their own copy of the forked codebase (which can easily be synced with the main copy). The forked repository is then used to submit a request to the base repository to “pull” a set of changes. For more information on pull requests please refer to [GitHub Help](https://help.github.com/articles/about-pull-requests/). +Contributions to the TAO codebase are made using the fork & pull model. +This contribution model has contributors maintaining their own copy of the forked codebase (which can easily be synced with the main copy). The forked repository is then used to submit a request to the base repository to “pull” a set of changes. For more information on pull requests, please refer to [GitHub Help](https://help.github.com/articles/about-pull-requests/). -The TAO development team will review all issues and contributions submitted by the community of developers in the first in, first out order. During the review we might require clarifications from the contributor. If there is no response from the contributor within two weeks, the pull request will be closed. +The TAO development team will review all issues and contributions submitted by the community of developers in the first in, first out order. During the review, we might require clarifications from the contributor. If there is no response from the contributor within two weeks, the pull request will be closed. ## Contribution process -If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free). This will allow you to collaborate with the TAO development team, fork the TAO project and send pull requests. +If you are a new GitHub user, we recommend that you create your own [free GitHub account](https://github.com/signup/free). This will allow you to collaborate with the TAO development team, fork the TAO project and send pull requests. 1. Check the open an closed issues for similar proposals of intended contribution before starting work on a new contribution. 2. Create and test your work. -3. Fork the repository of the TAO extension you wish to contribute to. +3. Fork the repository of the TAO extension you wish to contribute. 4. Create a branch that follows the [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) branching model. -5. Once development has been done, create a pull request that targets the development branch of the extension you are contributing to. +5. Once development has been done, create a pull request that targets the development branch of the extension you are contributing. 6. If your code depends on changes in another extension, create a draft pull request, until all required pull requests are created. 7. Once your contribution is received the TAO development team will review the contribution and collaborate with you as needed. @@ -24,7 +24,7 @@ If you are a new GitHub user, we recommend that you create your own [free github ### Our Pledge In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and +contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and @@ -68,18 +68,17 @@ threatening, offensive, or harmful. This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed +representing a project or community include using an official project e-mail address, posting via an official social media account or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ### Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be +Instances of abusive, harassing or otherwise, unacceptable behavior may be reported by contacting the project team at [community@taotesting.com](mailto:community@taotesting.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. +obligated to maintain confidentiality concerning the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good From 90c60477fd6bd824d58d84673a1fef5d2846e8ff Mon Sep 17 00:00:00 2001 From: "Serge A. Salamanka" Date: Sat, 4 May 2019 13:21:02 +0300 Subject: [PATCH 6/7] Updated CoC with appropriate adjustment --- .github/CONTRIBUTING.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ccd97256b3..44727b5c16 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,7 +16,7 @@ If you are a new GitHub user, we recommend that you create your own [free GitHub 3. Fork the repository of the TAO extension you wish to contribute. 4. Create a branch that follows the [GitFlow](https://datasift.github.io/gitflow/IntroducingGitFlow.html) branching model. 5. Once development has been done, create a pull request that targets the development branch of the extension you are contributing. -6. If your code depends on changes in another extension, create a draft pull request, until all required pull requests are created. +6. If your code depends on changes in another extension, create a draft pull request, until all required pull requests are created. 7. Once your contribution is received the TAO development team will review the contribution and collaborate with you as needed. ## Code of Conduct @@ -25,10 +25,8 @@ If you are a new GitHub user, we recommend that you create your own [free GitHub In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. +our community a harassment-free experience for everyone, regardless of +any differences between us. ### Our Standards From 2a82ba1c7c7369e89525e83a042bc8ea0161fd35 Mon Sep 17 00:00:00 2001 From: Martijn Swinkels Date: Thu, 4 Jul 2019 18:07:03 +0200 Subject: [PATCH 7/7] Created seperate CoC file, and added short introduction to the contributing guidelines --- .github/CODE_OF_CONDUCT.md | 71 ++++++++++++++++++++++++++++++++++++ .github/CONTRIBUTING.md | 74 ++------------------------------------ 2 files changed, 73 insertions(+), 72 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..6216f20f62 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,71 @@ +# Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of +any differences between us. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail address, posting via an official social media account or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing or otherwise, unacceptable behavior may be +reported by contacting the project team at [community@taotesting.com](mailto:community@taotesting.com). All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality concerning the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4/][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 44727b5c16..6f2054b8fe 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contributing to TAO +The following is a set of guidelines for contributing to TAO and its extensions. + When contributing to the TAO project, please first discuss the change you wish to make via issue. Contributions to the TAO codebase are made using the fork & pull model. @@ -18,75 +20,3 @@ If you are a new GitHub user, we recommend that you create your own [free GitHub 5. Once development has been done, create a pull request that targets the development branch of the extension you are contributing. 6. If your code depends on changes in another extension, create a draft pull request, until all required pull requests are created. 7. Once your contribution is received the TAO development team will review the contribution and collaborate with you as needed. - -## Code of Conduct - -### Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to make participation in our project and -our community a harassment-free experience for everyone, regardless of -any differences between us. - -### Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or -advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -### Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -### Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail address, posting via an official social media account or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -### Enforcement - -Instances of abusive, harassing or otherwise, unacceptable behavior may be -reported by contacting the project team at [community@taotesting.com](mailto:community@taotesting.com). All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality concerning the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -### Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at [http://contributor-covenant.org/version/1/4/][version] - -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/