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
{{ message }}
This repository was archived by the owner on Jun 2, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-12Lines changed: 10 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,13 @@ information to effectively respond to your bug report or contribution.
11
11
12
12
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
13
14
-
When filing an issue, please check [existing open](https://github.com/aws/sagemaker-spark-serving-container/issues), or [recently closed](https://github.com/aws/sagemaker-spark-serving-container/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
14
+
When filing an issue, please check [existing open](https://github.com/aws/sagemaker-python-sdk/issues), or [recently closed](https://github.com/aws/sagemaker-python-sdk/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
15
15
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
16
17
17
* A reproducible test case or series of steps
18
18
* The version of our code being used
19
19
* Any modifications you've made relevant to the bug
20
-
*Anything unusual about your environment or deployment
20
+
*A description of your environment or deployment
21
21
22
22
23
23
## Contributing via Pull Requests
@@ -31,19 +31,17 @@ To send us a pull request, please:
31
31
32
32
1. Fork the repository.
33
33
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34
-
3. Ensure local tests pass.
35
-
4. Commit to your fork using clear commit messages.
36
-
5. Send us a pull request, answering any default questions in the pull request interface.
37
-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
34
+
3. Include unit tests when you contribute new features or make bug fixes, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost.
35
+
4. Ensure local tests pass.
36
+
5. Update the [changelog](https://github.com/aws/sagemaker-python-sdk/blob/master/CHANGELOG.rst) with a description of your changes for any code contribution.
37
+
6. Commit to your fork using [clear and imperative commit messages](https://chris.beams.io/posts/git-commit/).
38
+
7. Send us a pull request, answering any default questions in the pull request interface.
39
+
8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38
40
39
41
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40
42
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41
43
42
44
43
-
## Finding contributions to work on
44
-
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/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/sagemaker-spark-serving-container/labels/help%20wanted) issues is a great place to start.
45
-
46
-
47
45
## Code of Conduct
48
46
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49
47
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
@@ -56,6 +54,6 @@ If you discover a potential security issue in this project we ask that you notif
56
54
57
55
## Licensing
58
56
59
-
See the [LICENSE](https://github.com/aws/sagemaker-spark-serving-container/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
57
+
See the [LICENSE](https://github.com/aws/sagemaker-python-sdk/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
60
58
61
-
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
59
+
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
0 commit comments