diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 068f3d9..2323975 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,12 +1,3 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - --- name: Bug Report about: Create a report to help us improve. @@ -29,7 +20,7 @@ A clear description of what you expected to happen. Include error logs, stack traces, or screenshots if applicable. ## Environment -- Repo/Component: +- Project/Component: - Version/Commit: - Device/Browser/OS (if applicable): diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b8f8c42..adfcb6c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,12 +1,3 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - --- name: Feature Request about: Suggest an idea for this project. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..ad89210 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ +## Overview + +Clear description of the changes and the problem being solved. + +## Related Issues + +Fixes # (issue number) + +## Changes Made + +- [ ] List significant changes +- [ ] List UI changes (include screenshots if applicable) + +## Testing Done +Describe the steps you took to test these changes (please also list commands ran if possible). + +- [ ] Unit tests passed +- [ ] Integration tests passed +- [ ] Manual verification + +## Checklist + +- [ ] I have followed the style guidelines of this project. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] My changes generate no new warnings. + +--- +*Note: Only Maintainers can approve and merge PRs. Expected initial review time: 3 business days.* + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 654a071..1a0d5ba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,49 @@ -# How to Contribute +# Contributing to Data Commons -We'd love to accept your patches and contributions to this project. There are -just a few small guidelines you need to follow. +Thank you for your interest in Data Commons. This document outlines our contribution process and expectations. These guidelines apply to all repositories within the `datacommonsorg` GitHub organization. -## Contributor License Agreement +## Governance and Review Authority +* **Maintenance:** This project is maintained by the Data Commons team. +* **Merge Authority:** Only designated Maintainers have the authority to approve and merge Pull Requests (PRs). All merges to the main branch must be reviewed. +* **Service Levels:** We operate on a weekly rotation to ensure consistent engagement. We aim to: + * Acknowledge new issues/PRs within 1 business day. + * Provide technical feedback or triage within 3 business days. + +## Contribution Workflow +1. **Search First:** Before opening a new issue or PR, search existing items to ensure the topic hasn't already been addressed. +2. **Open an Issue:** For any significant change, please open an issue to discuss your proposal before submitting code. This ensures alignment with the project roadmap. +3. **Use Templates:** Use the provided Issue and PR templates to ensure we have the necessary context (repro steps, environment, etc.) to review your work. +4. **Code Style:** Follow the [Google Style Guides](https://google.github.io/styleguide/) relevant to the language you are using. + +## Large Feature Requests (RFC Process) +For complex additions—such as new ingestion pipelines, large-scale tooling, or architectural changes—we require a **Design Proposal (RFC)**. + +Maintainers will evaluate proposals based on: +* **Architectural Alignment:** Does the feature fit the core product vision? +* **Maintenance:** Can the contribution be supported long-term without excessive overhead? +* **Generality:** Is the feature broadly useful to the Data Commons ecosystem? + +## Policy on "The No" +To maintain project focus and code quality, we may decline contributions that: +* Fall outside the project's current scope or architectural vision. +* Introduce significant technical debt or maintenance burden. +* Duplicate existing functionality. + +## Communication +Please use **GitHub Issues** for all technical discussions, bug reports, and feature requests. +## Contributor License Agreement Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to to see your current agreements on file or to sign a new one. -You generally only need to submit a CLA once, so if you've already submitted one -(even if it was for a different project), you probably don't need to do it -again. - -## Code reviews - -All submissions, including submissions by project members, require review. We -use GitHub pull requests for this purpose. Consult -[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more -information on using pull requests. +You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again. ## Community Guidelines - This project follows [Google's Open Source Community Guidelines](https://opensource.google/conduct/). +--- +*By contributing, you agree that your contributions will be licensed under the project's existing Open Source license.* +