Skip to content

Commit

Permalink
update docs and add correct links (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
jdnurme authored Feb 13, 2024
1 parent f3370f7 commit c3f2c0c
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 5 deletions.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Expected Behavior


## Actual Behavior


## Steps to Reproduce the Problem

1.
1.
1.

## Specifications

- Version:
- Platform:
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Fixes #<issue_number_goes_here>

> It's a good idea to open an issue first for discussion.
- [ ] Tests pass
- [ ] Appropriate changes to documentation are included in the PR
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ This is the git repository for the Dataflux Python client library.

# Contributing

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.
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.

# Code of Conduct

This project has adopted the Google Open Source Code of Conduct. Please see [code-of-conduct.md](ADD LINK) for more information.
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.

# License

The GCS Dataflux Dataset for PyTorch has an Apache License 2.0. Please see the [LICENSE](ADD LINK) file for more information.
The GCS Dataflux Dataset for PyTorch has an Apache License 2.0. Please see the [LICENSE](LICENSE) file for more information.
4 changes: 2 additions & 2 deletions docs/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ dispute. If you are unable to resolve the matter for any reason, or if the
behavior is threatening or harassing, report it. We are dedicated to providing
an environment where participants feel welcome and safe.

Reports should be directed to *[PROJECT STEWARD NAME(s) AND EMAIL(s)]*, the
Project Steward(s) for *[PROJECT NAME]*. It is the Project Steward’s duty to
Reports should be directed to [email protected], the
Project Steward(s) for Dataflux. It is the Project Steward’s duty to
receive and address reported violations of the code of conduct. They will then
work with a committee consisting of representatives from the Open Source
Programs Office and the Google Open Source Strategy team. If for any reason you
Expand Down

0 comments on commit c3f2c0c

Please sign in to comment.