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.

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

chore: Add initial templates for new issues and pull requests #1413

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a bug report to help us improve DVT
title: ''
labels: 'type: bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**What version of DVT are you using?**
Ex: 7.1.0

**What type of connections are you using for source and target?**
Ex: Postgres 15 for source, Teradata for target

**Steps to reproduce the behavior**
Ex: 1. Add '...'
2. Execute '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**How are you executing DVT?**
Ex: CLI commands on local computer or VM, within a DAG, Cloud Run job, etc

**Additional context**
Add any other context about the problem here.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'type: feature request'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**What version of DVT are you using?**
Ex: 7.1.0

**What type of connections are you using for source and target?**
Ex: Postgres 15 for source, Teradata for target

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**How are you executing DVT?**
Ex: CLI commands on local computer or VM, within a DAG, Cloud Run job, etc

**Additional context**
Add any other context or screenshots about the feature request here.
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!--
Thanks for taking the time to contribute to DVT!

Please ensure that your pull request title matches the conventional commits
specification: https://github.com/GoogleCloudPlatform/professional-services-data-validator/blob/develop/CONTRIBUTING.md#conventional-commits
-->

## Description of changes
_Write a description of the changes you have made in this PR. Extremely small changes such as fixing typos do not need a description._

## Issues to be closed
_Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google._

Closes #ISSUE_NUMBER

<!--
For example, if your pull requests resolves issues 1000 and 2000 write:
* Closes #1000
* Closes #2000
-->

## Checklist
- [ ] I have followed the [`CONTRIBUTING` Guide](https://github.com/GoogleCloudPlatform/professional-services-data-validator/blob/develop/CONTRIBUTING.md).
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have successfully run the E2E tests, and have included the outcomes in the PR comments
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like some people (especially external contributors) use PRs as a way of running the tests.. so maybe that shouldn't be a checklist item.

- [ ] I have added unit and integration tests relevant to my change as needed
- [ ] New and existing unit tests pass locally with my changes (suggestion: use the `tests/local_check.sh` script)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove this since the bullet above should imply the tests work 😅

- [ ] I have updated any relevant documentation to reflect my changes
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ Guidelines](https://opensource.google/conduct/).

Clone repo locally and install via pip:

```
```bash
git clone [email protected]:GoogleCloudPlatform/professional-services-data-validator.git
cd professional-services-data-validator/

python -m venv env
source env/bin/activate
python -m pip install --upgrade pip
Expand All @@ -52,17 +53,15 @@ See [our script](tests/local_check.sh) for using nox to run tests step by step.

You can also run pytest directly:
```python
pip install pyfakefs==4.6.2
pip install pytest pytest-cov pyfakefs==4.6.2 freezegun
pytest tests/unit
```

To lint your code, run:
```
pip install black==22.3.0
pip install flake8
```bash
pip install black==22.3.0 flake8
black $BLACK_PATHS # Find this variable in our noxfile
flake8 data_validation
flake8 tests
flake8 data_validation tests
```
The above is similar to our [noxfile lint test](https://github.com/GoogleCloudPlatform/professional-services-data-validator/blob/develop/noxfile.py).

Expand Down