|
| 1 | +## How to contribute to Spring Cloud AWS |
| 2 | + |
| 3 | +#### **Did you find a bug?** |
| 4 | + |
| 5 | +* **Do not open up a GitHub issue if the bug is a security vulnerability |
| 6 | + in Spring Cloud AWS**, and instead to refer to our [security policy](https://github.com/awspring/spring-cloud-aws/blob/main/SECURITY.md). |
| 7 | + |
| 8 | +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/awspring/spring-cloud-aws/issues). |
| 9 | + |
| 10 | +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/awspring/spring-cloud-aws/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, ideally with a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. |
| 11 | + |
| 12 | +#### **Did you write a patch that fixes a bug?** |
| 13 | + |
| 14 | +* Open a new GitHub pull request with the patch. |
| 15 | + |
| 16 | +* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. |
| 17 | + |
| 18 | +#### **Do you intend to add a new feature or change an existing one?** |
| 19 | + |
| 20 | +* Suggest your change in the [Issues](https://github.com/awspring/spring-cloud-aws/issues). |
| 21 | + |
| 22 | +* Start writing code once the issue got approved by project maintainers. |
| 23 | + |
| 24 | +* In addition to actual implemented feature, remember to: |
| 25 | + |
| 26 | + * update reference docs |
| 27 | + * consider providing/updating one of the [sample applications](https://github.com/awspring/spring-cloud-aws/tree/main/spring-cloud-aws-samples) |
| 28 | + * each public class should have a Javadoc |
| 29 | + * code has to have tests |
| 30 | + * each package has to have `package-info.java` file definining nullability rules ([example](https://github.com/awspring/spring-cloud-aws/blob/main/spring-cloud-aws-core/src/main/java/io/awspring/cloud/core/package-info.java)) |
| 31 | + * each nullable field, method parameter, method return value, if can be null, has to be annotated with `org.springframework.lang.Nullable`. |
| 32 | + |
| 33 | +#### **Do you have questions about the source code?** |
| 34 | + |
| 35 | +* Ask any question about how to use Spring Cloud AWS in the [Discussions](https://github.com/awspring/spring-cloud-aws/discussions). |
| 36 | + |
| 37 | +Thanks! |
0 commit comments