Skip to content

docs: improve the PR template#1213

Open
Panquesito7 wants to merge 3 commits intomasterfrom
improve_pr_template
Open

docs: improve the PR template#1213
Panquesito7 wants to merge 3 commits intomasterfrom
improve_pr_template

Conversation

@Panquesito7
Copy link
Member

@Panquesito7 Panquesito7 commented Oct 19, 2022

Describe your change

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?
  • Miscellaneous changes?

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, and userProfile.js are not.
  • All new algorithms have a URL in their comments that points to Wikipedia or similar explanations.
  • If this pull request resolves one or more open issues, add Closes: #{$ISSUE_NO} to this PR.

@Panquesito7 Panquesito7 added the documentation PR that adds or fixes docs; issue that points out issues with the docs label Oct 19, 2022
appgurueu
appgurueu reviewed Oct 19, 2022
View reviewed changes
Copy link
Collaborator

@appgurueu appgurueu left a comment

Choose a reason for hiding this comment

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

I'd prefer it if we could simplify the PR template rather than complicating it further…

@Panquesito7
Copy link
Member Author

Panquesito7 commented Dec 18, 2022

I'd prefer it if we could simplify the PR template rather than complicating it further…

What do you suggest/think we should do?

@appgurueu
Copy link
Collaborator

appgurueu commented Dec 18, 2022

I'd prefer it if we could simplify the PR template rather than complicating it further…

What do you suggest/think we should do?

Perhaps get rid of the checklist? It adds no value for reviewers; it should be "private" to the PR author.

@stale
Copy link

stale bot commented Jun 18, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Closed due to age label Jun 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@raklaptudirm raklaptudirm Awaiting requested review from raklaptudirm raklaptudirm is a code owner

@appgurueu appgurueu Awaiting requested review from appgurueu appgurueu is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

documentation PR that adds or fixes docs; issue that points out issues with the docs stale Closed due to age

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Panquesito7 @appgurueu