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

Add note in CONTRIBUTING.md about not asking to be assigned to issues #8871

Merged
merged 3 commits into from
Jul 22, 2023

Conversation

tianyizheng02
Copy link
Contributor

Describe your change:

Following #8866, I've added a paragraph to CONTRIBUTING.md explicitly asking contributors to not ask to be assigned to issues. Although we don't assign issues in this repo, this was never actually stated in the contributing guidelines.

  • 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".

Add a paragraph to CONTRIBUTING.md explicitly asking contributors to not ask to be assigned to issues
@tianyizheng02
Copy link
Contributor Author

@cclauss @dhruvmanila Could I get a review?

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

Nice!!

@cclauss cclauss merged commit f7531d9 into TheAlgorithms:master Jul 22, 2023
3 checks passed
@tianyizheng02 tianyizheng02 deleted the patch-1 branch July 22, 2023 10:11
@cclauss
Copy link
Member

cclauss commented Sep 25, 2023

It would be nice if this content had a markdown anchor so that we could point visitors directly to it.

Example: #8063 (comment)

@tianyizheng02
Copy link
Contributor Author

It would be nice if this content had a markdown anchor so that we could point visitors directly to it.

@cclauss That content is already under the Contribution section: https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md#contribution. Do you mean we should have an even more specific Markdown anchor to point to that specific paragraph?

@cclauss
Copy link
Member

cclauss commented Sep 30, 2023

Yes. That specific paragraph. Same for need for type hints. Same for need for tests, etc.

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