diff --git a/.github/PULL_REQUEST_TEMPLATE/doc_index_template.md b/.github/PULL_REQUEST_TEMPLATE/doc_index_template.md new file mode 100644 index 0000000000000..cb599faa4bb3b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/doc_index_template.md @@ -0,0 +1,27 @@ + + +# Doc Indexing Request (Package Naming Review) + +## Package Name + + +## Source Code Respository URL: + + +## License Checks + +* [ ] All packages have a declared license in the package.xml +* [ ] This repository has a LICENSE file + +## Package Name REP-144 Mandatory Checks + +* [ ] Only consists of lowercase alphanumerics and _ separators +* [ ] Starts with an alphabetic character +* [ ] Does not use multiple _ separators consecutively +* [ ] At least two characters long diff --git a/.github/PULL_REQUEST_TEMPLATE/rosdep_rule_template.md b/.github/PULL_REQUEST_TEMPLATE/rosdep_rule_template.md new file mode 100644 index 0000000000000..421c80f9dca4f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/rosdep_rule_template.md @@ -0,0 +1,45 @@ + + +# Adding Dependency to Rosdep Databse + +## Package name: + + +## Package Upstream Source: + + +## Purpose of using this: + + +## Links to Distribution Packages + +- Debian: https://packages.debian.org/ + - REQUIRED +- Ubuntu: https://packages.ubuntu.com/ + - REQUIRED +- Fedora: https://packages.fedoraproject.org/ + - IF AVAILABLE +- Arch: https://www.archlinux.org/packages/ + - IF AVAILABLE +- Gentoo: https://packages.gentoo.org/ + - IF AVAILABLE +- macOS: https://formulae.brew.sh/ + - IF AVAILABLE +- Alpine: https://pkgs.alpinelinux.org/packages + - IF AVAILABLE +- NixOS/nixpkgs: https://search.nixos.org/packages + - OPTIONAL +- openSUSE: https://software.opensuse.org/package/ + - IF AVAILABLE +- rhel: https://rhel.pkgs.org/ + - IF AVAILABLE diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index aa83a2cfa45f5..9fb833344bef0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,66 +1,16 @@ - + + -If you're making a new release with bloom please use bloom to create the pull request automatically (except for the naming review request which must be made manually). -If you've already run the release bloom has a `--pull-request-only` option you can use.--> +# Pull Request Template Selection - +Thank you for looking to contribute a change to the rosdistro. There are two primary types of contributions: -Please add the following dependency to the rosdep database. +* [**Rosdep Rule Template**](?expand=1&template=rosdep_rule_template.md) - Use this template to add a dependency of a platform to the rosdep database. +* [**Doc Index Template**](?expand=1&template=doc_index_template.md) - Use this template to request naming review of a package and addition of a "doc" entry in rosdistro. -## Package name: +**Please click on one of the templates above** and it will redirect you to the appropriate pull request template. -TODO +--- -## Package Upstream Source: - -TODO link to source repository - -## Purpose of using this: - -TODO Replace. This dependency is being used for this reason. This is why I think it's valuable to be added to the rosdep database. - -Distro packaging links: - -## Links to Distribution Packages - - - -- Debian: https://packages.debian.org/ - - REQUIRED -- Ubuntu: https://packages.ubuntu.com/ - - REQUIRED -- Fedora: https://packages.fedoraproject.org/ - - IF AVAILABLE -- Arch: https://www.archlinux.org/packages/ - - IF AVAILABLE -- Gentoo: https://packages.gentoo.org/ - - IF AVAILABLE -- macOS: https://formulae.brew.sh/ - - IF AVAILABLE -- Alpine: https://pkgs.alpinelinux.org/packages - - IF AVAILABLE -- NixOS/nixpkgs: https://search.nixos.org/packages - - OPTIONAL -- openSUSE: https://software.opensuse.org/package/ - - IF AVAILABLE -- rhel: https://rhel.pkgs.org/ - - IF AVAILABLE - - - - - -# Please Add This Package to be indexed in the rosdistro. - -ROSDISTRO NAME - -# The source is here: - -http://sourcecode_url - -# Checks - - [ ] All packages have a declared license in the package.xml - - [ ] This repository has a LICENSE file - - [ ] This package is expected to build on the submitted rosdistro +> **_NOTE:_** If you're making a new release with bloom please use bloom to create the pull request automatically (except for the naming review request which must be made manually). If you've already run the release bloom has a `--pull-request-only` option you can use.