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

Update contributing guidelines to say not to open new issues for algorithms #9760

Merged

Conversation

ChrisO345
Copy link
Collaborator

Describe your change:

  • Added a markdown header under Contributing for issues.
  • Added paragraph to say not to open new issues
  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

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 Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@cclauss cclauss merged commit dffbe45 into TheAlgorithms:master Oct 5, 2023
3 checks passed
@tianyizheng02
Copy link
Contributor

@cclauss @ChrisO345 We also need to update our issue templates to reflect this. Currently the "feature request" issue template explicitly states that it's fine to open issues for new algorithms.

screenshot

@cclauss
Copy link
Member

cclauss commented Oct 6, 2023

Agreed... Let's make those edits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants