-
Notifications
You must be signed in to change notification settings - Fork 121
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
helensilva14
wants to merge
10
commits into
develop
Choose a base branch
from
1349-add-issue-templates
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+98
−7
Open
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
15fc9d1
Add initial issue templates
helensilva14 c9ec05f
Create PULL_REQUEST_TEMPLATE.md
helensilva14 6ae150b
Update CONTRIBUTING.md
helensilva14 e1708df
Update CONTRIBUTING.md
helensilva14 7b1bf31
Update CONTRIBUTING.md
helensilva14 af33504
Remove duplicated folder
helensilva14 54da55f
Merge branch 'develop' into 1349-add-issue-templates
helensilva14 e9feb55
Merge branch 'develop' into 1349-add-issue-templates
helensilva14 6da44f2
Merge branch 'develop' into 1349-add-issue-templates
helensilva14 adc4eac
Update .github/PULL_REQUEST_TEMPLATE.md
helensilva14 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
helensilva14 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [ ] New and existing unit tests pass locally with my changes (suggestion: use the `tests/local_check.sh` script) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
@@ -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). | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.