Skip to content

Clarify how to be added to allow list #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2,221 commits into from

Conversation

Arthur-Milchior
Copy link
Contributor

On first reading, I found very confusing to understand how I could be added to
allow list. I just tried creating the PR anyway and discovered that the first
message by your bot explains how to add someone. I believe that it would improve
first user interaction if they already knew how to find this user that may allow
them. (Even better would be to have it automated, but that's a more complex task
I don't dare to try to work on)

dependabot bot and others added 30 commits May 30, 2022 16:01
Bumps [test-smtp-server](https://github.com/webstech/test-smtp-server) from 0.9.2 to 0.9.3.
- [Release notes](https://github.com/webstech/test-smtp-server/releases)
- [Commits](https://github.com/webstech/test-smtp-server/commits)

---
updated-dependencies:
- dependency-name: test-smtp-server
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [commander](https://github.com/tj/commander.js) from 9.2.0 to 9.3.0.
- [Release notes](https://github.com/tj/commander.js/releases)
- [Changelog](https://github.com/tj/commander.js/blob/master/CHANGELOG.md)
- [Commits](tj/commander.js@v9.2.0...v9.3.0)

---
updated-dependencies:
- dependency-name: commander
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) from 39.3.0 to 39.3.2.
- [Release notes](https://github.com/gajus/eslint-plugin-jsdoc/releases)
- [Commits](gajus/eslint-plugin-jsdoc@v39.3.0...v39.3.2)

---
updated-dependencies:
- dependency-name: eslint-plugin-jsdoc
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
…lint-plugin-jsdoc-39.3.2

build(deps-dev): bump eslint-plugin-jsdoc from 39.3.0 to 39.3.2
…mander-9.3.0

build(deps): bump commander from 9.2.0 to 9.3.0
…t-smtp-server-0.9.3

build(deps-dev): bump test-smtp-server from 0.9.2 to 0.9.3
…escript-4.7.2

build(deps-dev): bump typescript from 4.6.4 to 4.7.2
…escript-eslint/parser-5.26.0

build(deps-dev): bump @typescript-eslint/parser from 5.25.0 to 5.26.0
Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 26.2.2 to 26.4.5.
- [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases)
- [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md)
- [Commits](jest-community/eslint-plugin-jest@v26.2.2...v26.4.5)

---
updated-dependencies:
- dependency-name: eslint-plugin-jest
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
…int-plugin-jest-26.4.5

build(deps-dev): bump eslint-plugin-jest from 26.2.2 to 26.4.5
The ncc tool does not seem to support 'require' on the import
statement.  Changing to 'from', which works with current
tooling (tsc, ncc).

Signed-off-by: Chris. Webster <[email protected]>
Make workdir required for CIHelper (always passed anyway).  Also
set some values using the config instead of assuming git.

Make workdir required for GitHubGlue and add owner for
authentication use.  Having owner removes the need to authenticate
ahead of any other calls.

Signed-off-by: Chris. Webster <[email protected]>
All external packages must be identified in order for
gitgitgadget to be used as an npm package.

Signed-off-by: Chris. Webster <[email protected]>
Updates to support packaging and more config support
We recently had a problem where Google stopped allowing "less-secure
access" by third-party apps, forcing us to switch to using app
passwords.

The biggest problem, however, was that the Pipeline runs were marked as
_successful_, even if the run should have been marked as failure because
the patch series was not sent successfully.

The reason is that caught the exception (and displayed an error) without
actually erroring out. This patch fixes that.

Signed-off-by: Johannes Schindelin <[email protected]>
When running as part of a workflow, the secrets are set in
the environment.  This removes the need to add them to a git
config, reducing the risk of exposure.  The '--gitgitgadget-work-dir'
is no longer needed (except for the generated app key).

Signed-off-by: Chris. Webster <[email protected]>
Prefer environment vars over config values
Bumps [eslint](https://github.com/eslint/eslint) from 8.16.0 to 8.17.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](eslint/eslint@v8.16.0...v8.17.0)

---
updated-dependencies:
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [@types/jest](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/jest) from 27.5.1 to 28.1.1.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/jest)

---
updated-dependencies:
- dependency-name: "@types/jest"
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [ts-jest](https://github.com/kulshekhar/ts-jest) from 28.0.3 to 28.0.4.
- [Release notes](https://github.com/kulshekhar/ts-jest/releases)
- [Changelog](https://github.com/kulshekhar/ts-jest/blob/main/CHANGELOG.md)
- [Commits](kulshekhar/ts-jest@v28.0.3...v28.0.4)

---
updated-dependencies:
- dependency-name: ts-jest
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
…lint-8.17.0

build(deps-dev): bump eslint from 8.16.0 to 8.17.0
…pes/jest-28.1.1

build(deps-dev): bump @types/jest from 27.5.1 to 28.1.1
…-jest-28.0.4

build(deps-dev): bump ts-jest from 28.0.3 to 28.0.4
Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 26.4.5 to 26.5.3.
- [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases)
- [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md)
- [Commits](jest-community/eslint-plugin-jest@v26.4.5...v26.5.3)

---
updated-dependencies:
- dependency-name: eslint-plugin-jest
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 5.26.0 to 5.27.1.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v5.27.1/packages/eslint-plugin)

---
updated-dependencies:
- dependency-name: "@typescript-eslint/eslint-plugin"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [ts-node](https://github.com/TypeStrong/ts-node) from 10.8.0 to 10.8.1.
- [Release notes](https://github.com/TypeStrong/ts-node/releases)
- [Commits](TypeStrong/ts-node@v10.8.0...v10.8.1)

---
updated-dependencies:
- dependency-name: ts-node
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
…lint-plugin-jest-26.5.3

build(deps-dev): bump eslint-plugin-jest from 26.4.5 to 26.5.3
…pescript-eslint/eslint-plugin-5.27.1

build(deps-dev): bump @typescript-eslint/eslint-plugin from 5.26.0 to 5.27.1
…-node-10.8.1

build(deps-dev): bump ts-node from 10.8.0 to 10.8.1
…demailer-6.8.0

build(deps): bump nodemailer from 6.7.8 to 6.8.0
@dscho
Copy link
Member

dscho commented Oct 6, 2022

@Arthur-Milchior Are you still interested in this PR?

dscho and others added 24 commits October 7, 2022 15:40
This really does not do justice to the project yet, but it is
*something*.

Signed-off-by: Johannes Schindelin <[email protected]>
Signed-off-by: Johannes Schindelin <[email protected]>
By mistake, this page was updated as Markdown, but it is a static web
page, so it really needs to be HTML...

Signed-off-by: Johannes Schindelin <[email protected]>
Signed-off-by: Johannes Schindelin <[email protected]>
Better explanation, some CSS experiments, fun all around.

Signed-off-by: Johannes Schindelin <[email protected]>
Since the SubmittingPatches page is nicely formatted on the Git website, 
it makes for a nicer reading experience, so let's link to that instead of the raw file on GitHub.
Signed-off-by: Johannes Schindelin <[email protected]>
Mark HTML files as such with the 'diff' attribute, so that the
appropriate '<h[1-9]>' title is shown in the hunk header in diffs.
In a subsequent commit we want to mention that it is prefered to use an
empty desccription for a single commit PR, since the description is
copied as an in-patch commentary and having the same text twice (once in
the commit messge and once in the in-patch commentary) decreases
the signal-to-noise ratio for reviewers.

Before doing so, let's convert part of the first paragraph of the "How
can you use GitGitGadget?" section into an unorderded list. This will
make the text clearer when we mention single commit PRs later.
We refer readers to the MyFirstContribution tutorial when mentioning the
cover letter. Let's do even better and link directly to the section of
the tutorial that explains the purpose and content of the cover letter.
For single commit PRs, GitHub prepends the commit message to the PR
description, before the PR template.

Contributors will then (hopefully) remove the template and keep the rest
of the description. Since the PR description is added as an in-patch
commentary for single-commit PRs, the same text appears twice in the
generatred email (once in the commit messge and once in the in-patch
commentary), decreasing the signal-to-noise ratio for reviewers.

Let's instruct readers to empty the PR description for single commit
PRs.

This partly addresses:
gitgitgadget/gitgitgadget#340
On first reading, I found very confusing to understand how I could be added to
allow list. I just tried creating the PR anyway and discovered that the first
message by your bot explains how to add someone. I believe that it would improve
first user interaction if they already knew how to find this user that may allow
them. (Even better would be to have it automated, but that's a more complex task
I don't dare to try to work on)
Copy link
Contributor Author

@Arthur-Milchior Arthur-Milchior left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pinging.
I fear I have let more than a thousand open notification in github, and so sometime some actual important ones fails through.
Correction done.

@@ -113,7 +113,8 @@ <h2>How can you use GitGitGadget?</h2>
You might also want to read the <a href="https://git-scm.com/docs/gitworkflows">gitworkflows</a> manual page to understand how your contributions will be integrated in Git's repository, as well as <a href="https://github.com/git/git/blob/todo/MaintNotes">this note from Git's maintainer</a>.
</p><p>
The first time you use GitGitGadget, you need to be added to the list of users with permission to use GitGitGadget (this is a <i>very</i> simple anti-spam measure).
Any user who is already on that list can do that, by adding a comment to that Pull Request that says <code>/allow &lt;username&gt;</name></code> (with your GitHub login name).
Using <a src="https://web.libera.chat/#git-devel">IRC</a>, <a src="https://github.com/gitgitgadget/git/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+%22%2Fallow%22">PRs</a> you can find a user already on this list and request them to add you to the list.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -113,7 +113,8 @@ <h2>How can you use GitGitGadget?</h2>
You might also want to read the <a href="https://git-scm.com/docs/gitworkflows">gitworkflows</a> manual page to understand how your contributions will be integrated in Git's repository, as well as <a href="https://github.com/git/git/blob/todo/MaintNotes">this note from Git's maintainer</a>.
</p><p>
The first time you use GitGitGadget, you need to be added to the list of users with permission to use GitGitGadget (this is a <i>very</i> simple anti-spam measure).
Any user who is already on that list can do that, by adding a comment to that Pull Request that says <code>/allow &lt;username&gt;</name></code> (with your GitHub login name).
Using <a src="https://web.libera.chat/#git-devel">IRC</a>, <a src="https://github.com/gitgitgadget/git/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+%22%2Fallow%22">PRs</a> you can find a user already on this list and request them to add you to the list.
To do so, they simply have to add a comment to that Pull Request that says <code>/allow &lt;username&gt;</name></code> (with your GitHub login name).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for letting me know. I was trying to rephrase the content I understood and didn't know it was not up to date

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants