3
3
We'd love to accept your patches and contributions to this project. There are
4
4
just a few small guidelines you need to follow.
5
5
6
+ ## Contributor License Agreement
7
+
8
+ First, the most important step: signing the Contributor License Agreement. We
9
+ cannot look at any of your code unless one is signed.
10
+
11
+ Contributions to this project must be accompanied by a Contributor License
12
+ Agreement. You (or your employer) retain the copyright to your contribution,
13
+ this simply gives us permission to use and redistribute your contributions as
14
+ part of the project. Head over to < https://cla.developers.google.com/ > to see
15
+ your current agreements on file or to sign a new one.
16
+
17
+ You generally only need to submit a CLA once, so if you've already submitted one
18
+ (even if it was for a different project), you probably don't need to do it
19
+ again.
20
+
6
21
## Getting started
7
22
8
23
Before we can work on the code, we need to get a copy of it and setup some
@@ -65,15 +80,6 @@ and setup. Subsequent runs will be faster, but there are many tests, and some of
65
80
them are slow. If you're working on a particular area of code, you can run just
66
81
the tests in those directories instead, which can speed up your edit-run cycle.
67
82
68
- ## Updating tool dependencies
69
-
70
- It's suggested to routinely update the tool versions within our repo - some of the
71
- tools are using requirement files compiled by ` uv ` and others use other means. In order
72
- to have everything self-documented, we have a special target -
73
- ` //private:requirements.update ` , which uses ` rules_multirun ` to run in sequence all
74
- of the requirement updating scripts in one go. This can be done once per release as
75
- we prepare for releases.
76
-
77
83
## Formatting
78
84
79
85
Starlark files should be formatted by
@@ -99,18 +105,6 @@ $ buildifier --lint=fix --warnings=native-py -warnings=all WORKSPACE
99
105
100
106
Replace the argument "WORKSPACE" with the file that you are linting.
101
107
102
- ## Contributor License Agreement
103
-
104
- Contributions to this project must be accompanied by a Contributor License
105
- Agreement. You (or your employer) retain the copyright to your contribution,
106
- this simply gives us permission to use and redistribute your contributions as
107
- part of the project. Head over to < https://cla.developers.google.com/ > to see
108
- your current agreements on file or to sign a new one.
109
-
110
- You generally only need to submit a CLA once, so if you've already submitted one
111
- (even if it was for a different project), you probably don't need to do it
112
- again.
113
-
114
108
## Code reviews
115
109
116
110
All submissions, including submissions by project members, require review. We
@@ -198,31 +192,6 @@ merged:
198
192
` compile_pip_requirements ` update target, which is usually in the same directory.
199
193
e.g. ` bazel run //docs:requirements.update `
200
194
201
- ## Core rules
202
-
203
- The bulk of this repo is owned and maintained by the Bazel Python community.
204
- However, since the core Python rules (` py_binary ` and friends) are still
205
- bundled with Bazel itself, the Bazel team retains ownership of their stubs in
206
- this repository. This will be the case at least until the Python rules are
207
- fully migrated to Starlark code.
208
-
209
- Practically, this means that a Bazel team member should approve any PR
210
- concerning the core Python logic. This includes everything under the ` python/ `
211
- directory except for ` pip.bzl ` and ` requirements.txt ` .
212
-
213
- Issues should be triaged as follows:
214
-
215
- - Anything concerning the way Bazel implements the core Python rules should be
216
- filed under [ bazelbuild/bazel] ( https://github.com/bazelbuild/bazel ) , using
217
- the label ` team-Rules-python ` .
218
-
219
- - If the issue specifically concerns the rules_python stubs, it should be filed
220
- here in this repository and use the label ` core-rules ` .
221
-
222
- - Anything else, such as feature requests not related to existing core rules
223
- functionality, should also be filed in this repository but without the
224
- ` core-rules ` label.
225
-
226
195
(breaking-changes)=
227
196
## Breaking Changes
228
197
0 commit comments