Skip to content

Commit 4887721

Browse files
documentation: update README and contributing guidelines
1 parent 41c5981 commit 4887721

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,41 @@ GitHub provides additional document on [forking a repository](https://help.githu
4040
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4141

4242

43+
### Committing your change
44+
45+
We use commit messages to update the project version number and generate changelog entries, so it's important for them to follow the right format. Valid commit messages include a prefix, separated from the rest of the message by a colon and a space. Here are a few examples:
46+
47+
```
48+
feature: support VPC config for hyperparameter tuning
49+
fix: fix flake8 errors
50+
documentation: add README documentation
51+
```
52+
53+
Valid prefixes are listed in the table below.
54+
55+
| Prefix | Use for... |
56+
|----------------:|:-----------------------------------------------------------------------------------------------|
57+
| `breaking` | Incompatible API changes. |
58+
| `deprecation` | Deprecating an existing API or feature, or removing something that was previously deprecated. |
59+
| `feature` | Adding a new feature. |
60+
| `fix` | Bug fixes. |
61+
| `change` | Any other code change. |
62+
| `documentation` | Documentation changes. |
63+
64+
Some of the prefixes allow abbreviation ; `break`, `feat`, `depr`, and `doc` are all valid. If you omit a prefix, the commit will be treated as a `change`.
65+
66+
For the rest of the message, use imperative style and keep things concise but informative. See [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) for guidance.
67+
68+
69+
### Sending a pull request
70+
71+
GitHub provides additional document on [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
72+
73+
Please remember to:
74+
* Use commit messages (and PR titles) that follow the guidelines under [Committing your change](#committing-your-change).
75+
* Send us a pull request, answering any default questions in the pull request interface.
76+
* Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
77+
4378
## Finding contributions to work on
4479
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-pytorch-training-toolkit/labels/help%20wanted) issues is a great place to start.
4580

README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ SageMaker PyTorch Training Toolkit
55

66
SageMaker PyTorch Training Toolkit is an open-source library for using PyTorch to train models on Amazon SageMaker.
77

8+
This toolkit depends and extends the base `SageMaker Training Toolkit <https://github.com/aws/sagemaker-training-toolkit>`__ with PyTorch specific support.
9+
810
For inference, see `SageMaker PyTorch Inference Toolkit <https://github.com/aws/sagemaker-pytorch-serving-container>`__.
911

1012
For the Dockerfiles used for building SageMaker PyTorch Containers, see `AWS Deep Learning Containers <https://github.com/aws/deep-learning-containers>`__.

0 commit comments

Comments
 (0)