From 59e53125de5ef10601866cfe06a8fd53e775965b Mon Sep 17 00:00:00 2001 From: JD Nurme Date: Tue, 13 Feb 2024 00:16:36 +0000 Subject: [PATCH] update docs and add correct links --- .github/ISSUE_TEMPLATE.md | 16 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 6 ++++++ README.md | 6 +++--- docs/code-of-conduct.md | 4 ++-- 4 files changed, 27 insertions(+), 5 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..3c52212 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,16 @@ +## Expected Behavior + + +## Actual Behavior + + +## Steps to Reproduce the Problem + +1. +1. +1. + +## Specifications + +- Version: +- Platform: \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..00550b6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,6 @@ +Fixes # + +> It's a good idea to open an issue first for discussion. + +- [ ] Tests pass +- [ ] Appropriate changes to documentation are included in the PR \ No newline at end of file diff --git a/README.md b/README.md index 2efda72..543c93f 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/code-of-conduct.md b/docs/code-of-conduct.md index c8d68a2..10f6242 100644 --- a/docs/code-of-conduct.md +++ b/docs/code-of-conduct.md @@ -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 dataflux-customer-support@google.com, 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