You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tooling.apache.org by sb...@apache.org on 2025/12/01 19:30:47 UTC
(tooling-trusted-releases) branch main updated: Make introduction mandatory for contributions to deter spam
This is an automated email from the ASF dual-hosted git repository.
sbp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-trusted-releases.git
The following commit(s) were added to refs/heads/main by this push:
new 5a469a1 Make introduction mandatory for contributions to deter spam
5a469a1 is described below
commit 5a469a167b55b65bbcb04cdfe8ec9804b4fdcb35
Author: Sean B. Palmer <se...@miscoranda.com>
AuthorDate: Mon Dec 1 19:30:22 2025 +0000
Make introduction mandatory for contributions to deter spam
---
README.md | 4 ++++
atr/docs/code-conventions.md | 2 +-
atr/docs/how-to-contribute.md | 2 ++
scripts/docs_check.py | 2 +-
4 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index dafa07e..5d514cc 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,8 @@
<img alt="Apache License" src="https://img.shields.io/github/license/apache/tooling-trusted-releases" />
</a>
+**NOTE: New contributors must introduce themselves on [the development mailing list first](mailto:dev@tooling.apache.org), to deter spam. Contributions are very welcome, but please do not submit a PR until you have introduced yourself first.**
+
## Status
This repository contains code developed by the **Apache Software Foundation (ASF) Tooling team**.
@@ -42,6 +44,8 @@ If you are an ASF committer or contributor interested in Trusted Releases:
3. **Share ideas or file issues:**
Use the [GitHub Issues](https://github.com/apache/tooling-trusted-releases/issues) page to report bugs, suggest features, or discuss improvements.
+As mentioned above, **new contributors must introduce themselves on the development mailing list first**, to deter spam. Contributions are very welcome, but please do not submit a PR until you have introduced yourself otherwise it will likely be rejected. Our [contribution guide](https://release-test.apache.org/docs/how-to-contribute) contains lots more useful information.
+
## License
This project is licensed under the [Apache License, Version 2.0](LICENSE).
diff --git a/atr/docs/code-conventions.md b/atr/docs/code-conventions.md
index 52389f5..007029f 100644
--- a/atr/docs/code-conventions.md
+++ b/atr/docs/code-conventions.md
@@ -57,7 +57,7 @@ When you find yourself nesting code more than two or three levels deep, extract
### Do not use lint or type checker ignore statements
-You must not use `# noqa`, `# type: ignore`, or equivalents such as `cast`, even to ignore specific errors. The single exception to this is when there is a bug in the linter or type checker. Such ignores should be scoped to the category of error being raised by the checker. We currently use pyright for checking, where one additional restriction is that ignores of the style `# type: ignore` or `# type: ignore[category]` must not be used.
+You must not use `# noqa`, `# type: ignore`, or equivalents such as `cast`, even to ignore specific errors. The single exception to this is when there is a bug in the linter or type checker. Such ignores should be scoped to the category of error being raised by the checker. We currently use pyright for type checking, where one additional restriction is that ignores of the style `# type: ignore` or `# type: ignore[category]` [must not be used](https://github.com/apache/tooling-trusted-rel [...]
File level lint ignores can be added to the project's `pyproject.toml`, but they must be used sparingly.
diff --git a/atr/docs/how-to-contribute.md b/atr/docs/how-to-contribute.md
index 52288a4..3b857c0 100644
--- a/atr/docs/how-to-contribute.md
+++ b/atr/docs/how-to-contribute.md
@@ -22,6 +22,8 @@ ATR is developed by ASF Tooling in public as open source code, and we welcome hi
This page explains how to contribute code and documentation to ATR. We recommend reading the [platform introduction](introduction-to-atr) and [overview of the code](overview-of-the-code) first to understand the purpose of ATR and how the codebase is structured. You should also read the [code conventions](code-conventions) page; we expect all contributions to follow those conventions.
+**IMPORTANT: New contributors must introduce themselves on [the development mailing list first](mailto:dev@tooling.apache.org), to deter spam.** Contributions are very welcome, but please do not submit a PR until you have introduced yourself first.
+
## Finding something to work on
The easiest way to find something to work on is to look at our [issue tracker](https://github.com/apache/tooling-trusted-releases/issues) on GitHub. We label [issues that are suitable for new contributors](https://github.com/apache/tooling-trusted-releases/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22) as `good first issue`. These are typically small, well-defined tasks that do not require deep familiarity with the entire codebase. Working on one of these issues [...]
diff --git a/scripts/docs_check.py b/scripts/docs_check.py
index a289302..908ae53 100755
--- a/scripts/docs_check.py
+++ b/scripts/docs_check.py
@@ -69,7 +69,7 @@ def _extract_links(file_path: pathlib.Path) -> list[Link]:
if target.startswith("/"):
continue
- if target.startswith("http://") or target.startswith("https://"):
+ if target.startswith("http://") or target.startswith("https://") or target.startswith("mailto:"):
continue
anchor = None
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@tooling.apache.org
For additional commands, e-mail: commits-help@tooling.apache.org