0
0
mirror of https://github.com/bpg/terraform-provider-proxmox.git synced 2025-06-30 02:31:10 +00:00

fix(docs): update CONTRIBUTING.md and other project docs (#771)

Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
This commit is contained in:
Pavel Boldyrev 2023-12-06 12:09:47 -05:00 committed by GitHub
parent a6772544f6
commit 7505b37708
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 28 additions and 15 deletions

View File

@ -2,7 +2,7 @@
name: Bug report
about: Create a report to help us improve
title: ""
labels: 'bug'
labels: '🐛 bug'
assignees: ''
---
@ -11,6 +11,7 @@ A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Create a resource '....'
2. Run '....'
3. See error
@ -28,6 +29,7 @@ If applicable, add screenshots to help explain your problem.
**Additional context**
Add any other context about the problem here.
- Single or clustered Proxmox:
- Provider version (ideally it should be the latest version):
- Terraform version:

View File

@ -2,7 +2,7 @@
name: Feature request
about: Suggest an idea for this project
title: ""
labels: 'enhancement'
labels: 'enhancement'
assignees: ''
---

View File

@ -5,7 +5,11 @@ Leave the [ ] if they are not applicable, or if you have not completed the item.
--->
- [ ] I have added / updated documentation in `/docs` for any user-facing features or additions.
- [ ] I have added / updated templates in `/example` for any new or updated resources / data sources.
- [ ] I have ran `make example` to verify that the change works as expected.
- [ ] I have ran `make example` to verify that the change works as expected.
<!---
You can find more information about coding conventions and local testing in the [CONTRIBUTING.md](https://github.com/bpg/terraform-provider-proxmox/blob/main/CONTRIBUTING.md) file.
--->
### Proof of Work
<!---
@ -15,8 +19,8 @@ Please add screenshots, logs, or other relevant information that demonstrates th
<!--- Please keep this note for the community --->
### Community Note
* Please vote on this pull request by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original pull request comment to help the community and maintainers prioritize this request
* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request
- Please vote on this pull request by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original pull request comment to help the community and maintainers prioritize this request
- Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request
<!--- Thank you for keeping this note for the community --->
<!--- If your PR fully resolves and should automatically close the linked issue, use Closes. Otherwise, use Relates --->

View File

@ -1,4 +1,5 @@
{
"MD013": false,
"MD025": false
"MD025": false,
"MD041": false
}

View File

@ -117,6 +117,9 @@ You can run `make lint` to lint your code.
We expect that all commit messages follow the
[Conventional Commits](https://www.conventionalcommits.org/) specification.
Please use the `feat`, `fix` or `chore` types for your commits, as they will
be used to automatically generate the changelog. Other types will be ignored
in the changelog.
Please use the `scope` field to indicate the area of the codebase that is being
changed. For example, `vm` for changes in the Virtual Machine resource, or
@ -139,10 +142,11 @@ For example:
feat(vm): add support for the `clone` operation
```
### Developer Certificate of Origin
In order for a code change to be accepted, you'll also have to accept the
Developer Certificate of Origin (DCO).
It's very lightweight, and you can find
it [here](https://developercertificate.org).
It's very lightweight, and you can find it [here](https://developercertificate.org).
Accepting is accomplished by signing off on your commits, you can do this by
adding a `Signed-off-by` line to your commit message, like here:
@ -152,14 +156,18 @@ feat(vm): add support for the `clone` operation
Signed-off-by: Random Developer <random@developer.example.org>
```
Git has a built-in flag to append this line automatically:
Please use your real name and a valid email address. If you'd like to keep your
email address private, you can use a GitHub-provided `noreply`` email address.
For more information, see "[Setting your commit email address.](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-on-github)"
If you set your `user.name` and `user.email` in Git, you can sign your commit
automatically with the `-s` flag:
```shell
> git commit -s -m 'feat(vm): add a cool new feature'
```
You can find more details about the DCO checker in
the [DCO app repo](https://github.com/dcoapp/app).
You can find more details about the DCO checker in the [DCO app repo](https://github.com/dcoapp/app).
## Submitting changes
@ -168,8 +176,7 @@ project's [pull request template](.github/PULL_REQUEST_TEMPLATE.md).
We usually squash all PRs commits on merge, and use the PR title as the commit
message. Therefore, the PR title should follow the
[Conventional Commits](https://www.conventionalcommits.org/) specification as
well.
[Conventional Commits](https://www.conventionalcommits.org/) specification as well.
## Releasing
@ -178,7 +185,6 @@ by [release-please](https://github.com/googleapis/release-please) GitHub Action.
creates a new release PR with the changelog and bumps the version based on the
commit messages. The release PR is merged by the maintainers.
The release will be published to the GitHub Releases page and the Terraform
Registry.
The release will be published to the GitHub Releases page and the Terraform Registry.
We aim to release a new version every 1-2 weeks.