Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

jsspric copyedit #519

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

jsspric copyedit #519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Pull request template
Use this template to submit pull requests.

### Description of changes:
## Description of changes:


#### Style and formatting:
### Style and formatting:

I have run `pre-commit install && pre-commit run --all-files` to ensure that auto-formatting happens with every commit.

#### Issue number, if available
### Issue number, if available:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
For more information, see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
[email protected] with any additional questions or comments.
37 changes: 19 additions & 18 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing Guidelines
# Contributing guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
documentation, we greatly value feedback and contributions from our community.
Expand All @@ -7,51 +7,51 @@ Please read through this document before submitting any issues or pull requests
information to effectively respond to your bug report or contribution.


## Reporting Bugs/Feature Requests
## Reporting bugs and requesting features

We welcome you to use the GitHub issue tracker to report bugs or suggest features.
Use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check [existing open](https://github.com/awslabs/sagemaker-debugger/issues), or [recently closed](https://github.com/awslabs/sagemaker-debugger/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
When filing an issue, check [existing open](https://github.com/awslabs/sagemaker-debugger/issues) or [recently closed](https://github.com/awslabs/sagemaker-debugger/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20) issues to make sure someone else hasn't already
reported the issue. Include as much information as you can. Details like these are incredibly useful:

* A reproducible test case or series of steps
* The version of our code being used
* Any modifications you've made relevant to the bug
* Anything unusual about your environment or deployment


## Contributing via Pull Requests
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
## Contributing through pull requests
We greatly appreciate contributions made through pull requests. Before sending us a pull request, ensure that:

1. You are working against the latest source on the *master* branch.
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
3. You open an issue to discuss any significant work; we would hate for your time to be wasted.

To send us a pull request, please:
To send us a pull request:

1. Fork the repository.
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.
2. Modify the source; 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.
3. Ensure local tests pass.
4. Commit to your fork using clear commit messages.
5. Send us a pull request, answering any default questions in the pull request interface.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
6. Pay attention to any automated CI failures reported in the pull request and stay involved in the conversation.

GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
GitHub provides additional documentation on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).


## Developing SageMaker Debugger
To develop on your machine, here are some tips:
Here are some tips for developing on your machine:
1. Remove any existing installation:
```
pip uninstall smdebug
```
2. Clone the package from source:
2. Clone the package from the source:
```
git clone https://github.com/awslabs/sagemaker-debugger
cd sagemaker-debugger
```
3. Installing in `develop` mode:
3. Install in `develop` mode:
```
python setup.py develop
```
Expand All @@ -61,8 +61,8 @@ pip install pre-commit
pre-commit install
```

## Finding contributions to work on
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/awslabs/sagemaker-debugger/labels/help%20wanted) issues is a great place to start.
## Finding ways to contribute
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/awslabs/sagemaker-debugger/labels/help%20wanted) issues is a great place to start.


## Code of Conduct
Expand All @@ -72,7 +72,8 @@ [email protected] with any additional questions or comments.


## Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
If you discover a potential security issue in this project we ask that you notify Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.



## Licensing
Expand Down
Loading