Skip to content

Commit

Permalink
Start a developer docs page (bazelbuild#413)
Browse files Browse the repository at this point in the history
* start a developer docs page
  • Loading branch information
aiuto authored Sep 2, 2021
1 parent 8a789d6 commit 9126ba8
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
* @aiuto
# Alternate reviewers: @philwo @fwe
* @aiuto @nacl

/deb_packages/ @MarkusTeufelberger @adragomir
/pkg/rpm/ @nacl
3 changes: 2 additions & 1 deletion CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
#
# Names should be added to this file as:
# Name <email address>

Andrew Psaltis <[email protected]>
Tony Aiuto <[email protected]>
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 28 additions & 0 deletions developers.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 9126ba8

Please sign in to comment.