From 5d5ea015114092c157311c4948f7cc3d8c8e7f8a Mon Sep 17 00:00:00 2001 From: Michał Gołębiowski-Owczarek Date: Tue, 4 Jan 2022 16:27:18 +0100 Subject: Docs: Replace `#NUMBER` Trac issue references with `trac-NUMBER` The GitHub UI treats `#NUMBER` as referring to its own issues which is confusing when in jQuery source it's usually referring to the old deprecated Trac instance at https://bugs.jquery.com. This change replaces all such Trac references with `trac-NUMBER`. A few of the references came with the Sizzle integration and referred to the Sizzle GitHub bug tracker. Those have been replaced with full links instead. A new entry describing issue reference conventions has been added to README. Closes gh-4993 --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 085ce3905..1f2c22f88 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,12 @@ In the spirit of open source software development, jQuery always encourages comm 2. [Core Style Guide](https://contribute.jquery.org/style-guide/js/) 3. [Writing Code for jQuery Foundation Projects](https://contribute.jquery.org/code/) +### References to issues/PRs + +GitHub issues/PRs are usually referenced via `gh-NUMBER`, where `NUMBER` is the numerical ID of the issue/PR. You can find such an issue/PR under `https://github.com/jquery/jquery/issues/NUMBER`. + +jQuery has used a different bug tracker - based on Trac - in the past, available under [bugs.jquery.com](https://bugs.jquery.com/). It is being kept in read only mode so that referring to past discussions is possible. When jQuery source references one of those issues, it uses the pattern `trac-NUMBER`, where `NUMBER` is the numerical ID of the issue. You can find such an issue under `https://bugs.jquery.com/ticket/NUMBER`. + Environments in which to use jQuery -------------------------------------- -- cgit v1.2.3