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
CONTRIBUTING file, internals, and FAQ cleanup #1513
Comments
Original Redmine Comment
|
Original Redmine Comment FAQ cleanup seemed obvious improvement, wiki now points at most recent release's bin/verilator FAQ. |
Original Redmine Comment This all looks good to me. I run perldoc on the .pod files, but agree that it is probably best to move them to .md to make them more accessible. CONTRIBUTING.md also looks good. However, I keep meaning to add some words somewhere about Verilator CI. Do you think that belongs in CONTRIBUTING.md or INTERNALS.md? I feel like the former might be better since we're already encouraging people to submit patches via GitHub branches. It's a very small step from there to getting CI running at which point people will get emails when their own branches break the build, which seems good since it will encourage people to clean up their own messes. Thoughts? Also, I'm only talking about CI on the main repo. verilator_ext_tests is an advance subject. |
Original Redmine Comment Todd, Good point, I agree we should mention Travis, can you please suggest what we should add? I suggest at bullet point in CONTRIBUTING, and probably a longer blurb in the internals doc - feel free to push an edit on the internals doc yourself to add whatever is appropriate. I'll hold off moving the internals to .md until I hear back. |
Original Redmine Comment Committed CONTRIBUTING.adoc and conversion of internals.pod to internals.adoc. Switched to asciidoc over markdown as markdown couldn't do a lot of stuff wanted with internals. Also it seems Redhat et al recommend asciidoc over markdown. Todd, added a bullet on Travis, feel free to update that, and also please add travis info to internals.adoc. Keeping this open as a reminder for that, thanks. |
Original Redmine Comment Sigh. Keeping this open as a reminder. |
Original Redmine Comment I've added a blurb in internals.adoc about the CI setup. |
Original Redmine Comment Thanks all. |
Author Name: Stefan Wallentowitz (@wallento)
Original Redmine Issue: 1513 from https://www.veripool.org
Original Assignee: Wilson Snyder (@wsnyder)
We should add a CONTRIBUTING file on toplevel that describes the required technical and legal steps to submit patches. It should point to this redmine instance (especially now that there is a copy on github) and explain the use of the CoO with sign off (https://github.com/wking/signed-off-by/blob/master/Documentation/SubmittingPatches) and mails.
The text was updated successfully, but these errors were encountered: