Skip to content

docs: improve the issue forms #1272

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

Merged
merged 1 commit into from
Dec 19, 2022
Merged

docs: improve the issue forms #1272

merged 1 commit into from
Dec 19, 2022

Conversation

Panquesito7
Copy link
Member

Open in Gitpod know more

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?
    • It is good to have a field for extra/additional information if the user wants to specify or tell something else that doesn't fit any of the provided fields in the issue form.
    • Blank issues were disabled in favor of the miscellaneous/another template, which asks the user for at least a bit of information, rather than letting the user create a blank issue. This can be better for the maintainers when checking out the issues, IMO.

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new JavaScript files are placed inside an existing directory.
  • All filenames should use the UpperCamelCase (PascalCase) style. There should be no spaces in filenames.
    Example:UserProfile.js is allowed but userprofile.js,Userprofile.js,user-Profile.js,userProfile.js are not
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@Panquesito7 Panquesito7 added the documentation PR that adds or fixes docs; issue that points out issues with the docs label Dec 19, 2022
@raklaptudirm raklaptudirm merged commit 7ea7d7b into master Dec 19, 2022
@raklaptudirm raklaptudirm deleted the issue_forms branch December 19, 2022 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation PR that adds or fixes docs; issue that points out issues with the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants