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

Bug: Docs on Contributing do not mention mandatory issue creation #1039

Open
1 of 5 tasks
exploide opened this issue Dec 23, 2024 · 0 comments
Open
1 of 5 tasks

Bug: Docs on Contributing do not mention mandatory issue creation #1039

exploide opened this issue Dec 23, 2024 · 0 comments
Labels
bug Something isn't working triage This issue requires triaging

Comments

@exploide
Copy link
Contributor

exploide commented Dec 23, 2024

Description:

I wanted to open a pull request. In preparation I had a look on CONTRIBUTING.md which sent me to the Wiki on Contributing.
I followed the requirements, e.g. ensured the commit is signed, pushed the commit to my fork, then attempted to open a new PR.
In the PR template a link to #672 appeared, which contains additional requirements like that an issue for discussion is mandatory before opening a PR.

This is kind of frustrating because it would be better to know that in advance.

I recommend adding every requirement to the Wiki page and link to that from the PR template instead of to the mentioned issue. This makes everything available in one place and is easier to find. I think a random closed issue is not the most appropriate place for this information.

(Additional point of view: The shorter and more condensed the docs on contributing are the better. Long documents might discourage potential contributors.)

Are you intending to fix this bug?

No

Component(s) Affected:

  • Documentation

Contributor Checklist:

  • I have searched the issue tracker to ensure this bug hasn't been reported before or is not already being addressed.
  • I have provided clear steps to reproduce the issue.
  • I have included relevant environment information details.
  • I have attached necessary supporting documents.
  • I have checked that any JSON files I am attempting to upload to BloodHound are valid.
@exploide exploide added bug Something isn't working triage This issue requires triaging labels Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working triage This issue requires triaging
Projects
None yet
Development

No branches or pull requests

1 participant