Start a developer docs page (#413)

* start a developer docs page
This commit is contained in:
aiuto 2021-09-01 21:42:29 -04:00 committed by GitHub
parent 8a789d65b4
commit 9126ba8074
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 42 additions and 4 deletions

View File

@ -1,4 +1,4 @@
* @aiuto
# Alternate reviewers: @philwo @fwe
* @aiuto @nacl
/deb_packages/ @MarkusTeufelberger @adragomir
/pkg/rpm/ @nacl

View File

@ -8,4 +8,5 @@
#
# Names should be added to this file as:
# Name <email address>
Andrew Psaltis <apsaltis@vmware.com>
Tony Aiuto <aiuto@google.com>

View File

@ -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

28
developers.md Normal file
View File

@ -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