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

[CR] Updates the contribution description with information regarding open issues #35445

Conversation

GediminasMasaitis
Copy link
Contributor

@GediminasMasaitis GediminasMasaitis commented Nov 10, 2019

Summary

SUMMARY: None

Purpose of change

There are open source projects which simply reject any PRs that don't reference open issues. I edited the contribution document, as suggested by @Mark#9561 on discord, to reflect the project's stance on this rule, and prevent confusion whether an issue is required to submit a PR.

Describe the solution

Explain that a GitHub issue is not required for a PR, but if none is referenced, the PR should be self-complete, that is - explaining itself fully without external references.

…issues.

This should prevent confusion for developers who are used to working in environments where the only changes accepted are ones which reference open issues, and prevent redundant issue submission for PRs that the developer has already implemented.
@GediminasMasaitis GediminasMasaitis changed the title Updates the contribution description with information regarding open issues [CR] Updates the contribution description with information regarding open issues Nov 10, 2019
@GediminasMasaitis
Copy link
Contributor Author

GediminasMasaitis commented Nov 10, 2019

It seems the PR was rejected because the validator is unhappy about the PR, since it doesn't have a Summary header. This is because none of the current suggested headers seemed fit for this PR. Perhaps consider adding a Meta or Documentation header to the PR categories?

@AMurkin
Copy link
Contributor

AMurkin commented Nov 10, 2019

You can choose
Summary: None

@ZhilkinSerg ZhilkinSerg added <Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs labels Nov 10, 2019
@kevingranade kevingranade merged commit 4710b1d into CleverRaven:master Nov 11, 2019
@GediminasMasaitis GediminasMasaitis deleted the update-guidelines-about-issue-requirement branch November 11, 2019 11:24
AMurkin pushed a commit to AMurkin/Cataclysm-DDA that referenced this pull request Nov 13, 2019
…issues. (CleverRaven#35445)

This should prevent confusion for developers who are used to working in environments where the only changes accepted are ones which reference open issues, and prevent redundant issue submission for PRs that the developer has already implemented.
AMurkin added a commit to AMurkin/Cataclysm-DDA that referenced this pull request Nov 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
<Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants