From 9126ba807416c76c16054fd5b7b35dbf348ecf11 Mon Sep 17 00:00:00 2001 From: aiuto Date: Wed, 1 Sep 2021 21:42:29 -0400 Subject: [PATCH] Start a developer docs page (#413) * start a developer docs page --- CODEOWNERS | 4 ++-- CONTRIBUTORS | 3 ++- README.md | 11 ++++++++++- developers.md | 28 ++++++++++++++++++++++++++++ 4 files changed, 42 insertions(+), 4 deletions(-) create mode 100644 developers.md diff --git a/CODEOWNERS b/CODEOWNERS index 802c413..b92c927 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,4 +1,4 @@ -* @aiuto -# Alternate reviewers: @philwo @fwe +* @aiuto @nacl /deb_packages/ @MarkusTeufelberger @adragomir +/pkg/rpm/ @nacl diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 4f093a2..ebef3ac 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -8,4 +8,5 @@ # # Names should be added to this file as: # Name - +Andrew Psaltis +Tony Aiuto diff --git a/README.md b/README.md index 449a074..d718203 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,15 @@ CI: * [examples](https://github.com/bazelbuild/rules_pkg/tree/main/examples) - Cookbook examples for using the rules. -Bazel now uses this rule set for packaging its distribution. Bazel +As of Bazel 4.x, Bazel uses this rule set for packaging its distribution. Bazel still contains a limited version of `pkg_tar` but its feature set is frozen. Any new capabilities will be added here. + +### For developers + +patching.md +README.md + +* [Contributor information](CONTRIBUTING.md) (including contributor license agreements) +* [Patch process](patching.md) +* [Coding guidelines](developers.md) and other developer information diff --git a/developers.md b/developers.md new file mode 100644 index 0000000..1307f6a --- /dev/null +++ b/developers.md @@ -0,0 +1,28 @@ +# rules_pkg - Information for Developers + +NOTE: This is a work in progress. It is only an outline at this point. + +TBD: Introduction + +## General + +- tests +- OS portability +- minimize tests +- repo structure + - more at build time than in the distribution + - some features do not work on all platforms + +## Starlark style + +- using analysis tests +- docstrings in attributes + +## Python style + +- import style as per #399 +- ... + +## Continuous testing + +- under .bazel_ci