Skip to content

Commit c3f2c0c

Browse files
authored
update docs and add correct links (#1)
1 parent f3370f7 commit c3f2c0c

4 files changed

Lines changed: 27 additions & 5 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Expected Behavior
2+
3+
4+
## Actual Behavior
5+
6+
7+
## Steps to Reproduce the Problem
8+
9+
1.
10+
1.
11+
1.
12+
13+
## Specifications
14+
15+
- Version:
16+
- Platform:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Fixes #<issue_number_goes_here>
2+
3+
> It's a good idea to open an issue first for discussion.
4+
5+
- [ ] Tests pass
6+
- [ ] Appropriate changes to documentation are included in the PR

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ This is the git repository for the Dataflux Python client library.
66

77
# Contributing
88

9-
We welcome your feedback, issues, and bug fixes. We have a tight roadmap at this time so if you have a major feature or change in functionality you'd like to contribute, please open a GitHub Issue for discussion prior to sending a pull request. Please see [CONTRIBUTING](ADD LINK) for more information on how to report bugs or submit pull requests.
9+
We welcome your feedback, issues, and bug fixes. We have a tight roadmap at this time so if you have a major feature or change in functionality you'd like to contribute, please open a GitHub Issue for discussion prior to sending a pull request. Please see [CONTRIBUTING](docs/contributing.md) for more information on how to report bugs or submit pull requests.
1010

1111
# Code of Conduct
1212

13-
This project has adopted the Google Open Source Code of Conduct. Please see [code-of-conduct.md](ADD LINK) for more information.
13+
This project has adopted the Google Open Source Code of Conduct. Please see [code-of-conduct.md](docs/code-of-conduct.md) for more information.
1414

1515
# License
1616

17-
The GCS Dataflux Dataset for PyTorch has an Apache License 2.0. Please see the [LICENSE](ADD LINK) file for more information.
17+
The GCS Dataflux Dataset for PyTorch has an Apache License 2.0. Please see the [LICENSE](LICENSE) file for more information.

docs/code-of-conduct.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ dispute. If you are unable to resolve the matter for any reason, or if the
6969
behavior is threatening or harassing, report it. We are dedicated to providing
7070
an environment where participants feel welcome and safe.
7171

72-
Reports should be directed to *[PROJECT STEWARD NAME(s) AND EMAIL(s)]*, the
73-
Project Steward(s) for *[PROJECT NAME]*. It is the Project Steward’s duty to
72+
Reports should be directed to dataflux-customer-support@google.com, the
73+
Project Steward(s) for Dataflux. It is the Project Steward’s duty to
7474
receive and address reported violations of the code of conduct. They will then
7575
work with a committee consisting of representatives from the Open Source
7676
Programs Office and the Google Open Source Strategy team. If for any reason you

0 commit comments

Comments
 (0)