You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+58-6
Original file line number
Diff line number
Diff line change
@@ -18,8 +18,9 @@
18
18
19
19
# Contributing Guidelines
20
20
21
-
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
22
-
documentation, we greatly value feedback and contributions from our community.
21
+
<!-- markdownlint-disable MD013 -->
22
+
Thank you for your interest in contributing to our project. Whether it's a [bug report](https://github.com/aws-powertools/powertools-lambda-python/issues/new?assignees=&labels=bug%2Ctriage&projects=&template=bug_report.yml&title=Bug%3A+TITLE), [new feature](https://github.com/aws-powertools/powertools-lambda-python/issues/new?assignees=&labels=feature-request%2Ctriage&projects=&template=feature_request.yml&title=Feature+request%3A+TITLE), [correction](https://github.com/aws-powertools/powertools-lambda-python/issues/new/choose), or [additional documentation](https://github.com/aws-powertools/powertools-lambda-python/issues/new?assignees=&labels=documentation%2Ctriage&projects=&template=documentation_improvements.yml&title=Docs%3A+TITLE), we greatly value feedback and contributions from our community.
23
+
<!-- markdownlint-enable MD013 -->
23
24
24
25
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
25
26
information to effectively respond to your bug report or contribution.
@@ -28,8 +29,9 @@ information to effectively respond to your bug report or contribution.
28
29
29
30
We welcome you to use the GitHub issue tracker to report bugs, suggest features, or documentation improvements.
30
31
31
-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
32
-
reported the issue. Please try to include as much information as you can.
32
+
<!-- markdownlint-disable MD013 -->
33
+
[When filing an issue](https://github.com/aws-powertools/powertools-lambda-python/issues/new/choose), please check [existing open](https://github.com/aws-powertools/powertools-lambda-python/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc), or [recently closed](https://github.com/aws-powertools/powertools-lambda-python/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can.
34
+
<!-- markdownlint-enable MD013 -->
33
35
34
36
## Contributing via Pull Requests
35
37
@@ -39,6 +41,56 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
39
41
2. You check existing open, and recently merged pull requests to make sure someone else hasn't addressed the problem already.
40
42
3. You open an [issue](https://github.com/aws-powertools/powertools-lambda-python/issues/new/choose) before you begin any implementation. We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
41
43
44
+
At a high level, these are the steps to get code merged in the repository - don't worry, nearly all of them are automated.
|**Docstring**| We use a slight variation of Numpy convention with markdown to help generate more readable API references. |
79
-
|**Style guide**| We use black as well as [Ruff](https://beta.ruff.rs/docs/) to enforce beyond good practices [PEP8](https://pep8.org/). We use type annotations and enforce static type checking at CI (mypy). |
131
+
|**Style guide**| We use black as well as [Ruff](https://beta.ruff.rs/docs/) to enforce beyond good practices [PEP8](https://pep8.org/). We use type annotations and enforce static type checking at CI (mypy). |
80
132
|**Core utilities**| Core utilities use a Class, always accept `service` as a constructor parameter, can work in isolation, and are also available in other languages implementation. |
81
133
|**Utilities**| Utilities are not as strict as core and focus on solving a developer experience problem while following the project [Tenets](https://docs.powertools.aws.dev/lambda/python/#tenets). |
82
134
|**Exceptions**| Specific exceptions live within utilities themselves and use `Error` suffix e.g. `MetricUnitError`. |
@@ -100,7 +152,7 @@ We group tests in different categories
100
152
101
153
## Finding contributions to work on
102
154
103
-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/help wanted/invalid/question/documentation), looking at any 'help wanted' issues is a great place to start.
155
+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/help wanted/invalid/question/documentation), [looking at any 'help wanted' issues is a great place to start](https://github.com/orgs/aws-powertools/projects/3/views/5?query=is%3Aopen+sort%3Aupdated-desc).
0 commit comments