MDEV-38363: Removed the pull_request_template.md as discussed in PR#4209 #4487
Conversation
gkodinov
added
the
MariaDB Foundation
gkodinov
changed the title
|
In #4209 the last comment before the announcement of this change suggested that CONTRIBUTING.md be updated with some instructions on creating pull requests. At the end of that file the link https://mariadb.com/kb/en/ probably should be replaced with https://mariadb.com/docs/ which is what it currently redirects to. By the way, the documentation does not appear mention how to contribute code; I was only able to find instructions on contributing to the documentation. |
and https://mariadb.org/get-involved/getting-started-for-developers/submitting-pull-request/ too, as needed |
note commit messages should be relatively self contained in communicating their purpose. |
I am working on updating contribute.md. But it needs more work than that. I will file a PR once I have it. |
Indeed. But again, it's a longer story. I need to first come up with a proposal (work in progress), then vet it with some key internal stakeholders (work started) and only then can I have a PR for the changes to the above documents. In the meanwhile, we can all benefit from not shoving an old template into PR comment boxes. |
…tation rather than a pull request description. This was not really contriburing a lot towards good pull request descriptions as most of the time it had to be removed first before the actual descrption is written down. Removed the pull_request_template.md as discussed in PR#4209 Note that there is a follow-up work in progress (and it will eventually result in a pull request) to update the text in other contribution related documents. But removing this not-really-a-template template is going to produce an immediate improvement into the contribution process.
gkodinov
force-pushed
the
remove_pull_request_template_md
branch
from
685333a to
70113d0
Compare
II have added a more self-contained commit message now. |
svoj
left a comment
svoj
left a comment
There was a problem hiding this comment.
Please check git commit messages formatting section of CODING_STANDARDS.md and adjust your comment accordingly. Specifically split long lines.
The other question is if it should be committed against 10.6. github manual says only default branch matters.
LGTM otherwise.
According to the github manual, when someone opens a pull request or creates an issue, they will see a link to CONTRIBUTING.md file. I tried it and that was a small print in the best traditions of legal documents.
OTOH our CONTRIBUTING.md is way too generic for pull requests guidelines. And there're multiple kb pages containing similar information. I'd use either CODING_STANDARDS.md or create a new file that'd accumulate all relevant information (assuming it is decided that we shift towards github).
5 participants
This is a followup of PR#4209. It's about removing the pull_request_template.md file.