Skip to content

Commit c8f17a6

Browse files
authored
Add a contributing guide (#1115)
1 parent ebd86b9 commit c8f17a6

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing :heart:
2+
3+
Want to contribute? Great! First, read this page (including the small print at
4+
the end).
5+
6+
### Before you contribute
7+
8+
Before we can use your code, you must sign the
9+
[Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
10+
(CLA), which you can do online. The CLA is necessary mainly because you own the
11+
copyright to your changes, even after your contribution becomes part of our
12+
codebase, so we need your permission to use and distribute your code. We also
13+
need to be sure of various other things—for instance that you'll tell us if you
14+
know that your code infringes on other people's patents. You don't have to sign
15+
the CLA until after you've submitted your code for review and a member has
16+
approved it, but you must do it before we can put your code into our codebase.
17+
18+
Before you start working on a larger contribution, you should get in touch with
19+
us first through the issue tracker with your idea so that we can help out and
20+
possibly guide you. Coordinating up front makes it much easier to avoid
21+
frustration later on.
22+
23+
### Code reviews
24+
25+
All submissions, including submissions by project members, require review.
26+
27+
### File headers
28+
29+
All files in the project must start with the following header.
30+
31+
```dart
32+
// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
33+
// for details. All rights reserved. Use of this source code is governed by a
34+
// BSD-style license that can be found in the LICENSE file.
35+
```
36+
37+
### The small print
38+
39+
Contributions made by corporations are covered by a different agreement than the
40+
one above, the
41+
[Software Grant and Corporate Contributor License Agreement](https://developers.google.com/open-source/cla/corporate).
42+
43+
## A word about conduct
44+
45+
We pledge to maintain an open and welcoming environment :hugs:.
46+
For details, see our
47+
[code of conduct](https://dart.dev/community/code-of-conduct).

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,8 @@ and the browser.
1515
| [cronet_http](pkgs/cronet_http/) | An Android Flutter plugin that provides access to the [Cronet](https://developer.android.com/guide/topics/connectivity/cronet/reference/org/chromium/net/package-summary) HTTP client. | [![pub package](https://img.shields.io/pub/v/cronet_http.svg)](https://pub.dev/packages/cronet_http) |
1616
| [cupertino_http](pkgs/cupertino_http/) | A macOS/iOS Flutter plugin that provides access to the [Foundation URL Loading System](https://developer.apple.com/documentation/foundation/url_loading_system). | [![pub package](https://img.shields.io/pub/v/cupertino_http.svg)](https://pub.dev/packages/cupertino_http) |
1717
| [flutter_http_example](pkgs/flutter_http_example/) | An Flutter app that demonstrates how to configure and use `package:http`. ||
18+
19+
## Contributing
20+
21+
If you'd like to contribute to any of these packages, see the
22+
[Contributing Guide](CONTRIBUTING.md).

0 commit comments

Comments
 (0)