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

CONTRIBUTING file, internals, and FAQ cleanup #1513

Closed
veripoolbot opened this issue Sep 21, 2019 · 8 comments
Closed

CONTRIBUTING file, internals, and FAQ cleanup #1513

veripoolbot opened this issue Sep 21, 2019 · 8 comments

Comments

@veripoolbot
Copy link
Contributor

@veripoolbot veripoolbot commented Sep 21, 2019


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.

@veripoolbot
Copy link
Contributor Author

@veripoolbot veripoolbot commented Sep 28, 2019


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2019-09-28T15:08:18Z


  1. Currently the internals.pod file is used to make HTML/PDF/etc files. I doubt these are useful, is anyone using them? I'd propose to move this to docs/internals.md

  2. There's the FAQ on the wiki, and the FAQ in bin/verilator. I'm thinking merge the wiki into bin/verilator as then is more easily maintained.

  3. Please comment on the proposed CONTRIBUTING.md at "contrib-draft":https://github.com/wsnyder/verilator-contributing-draft/blob/master/CONTRIBUTING.md

@veripoolbot
Copy link
Contributor Author

@veripoolbot veripoolbot commented Sep 28, 2019


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2019-09-28T15:42:33Z


FAQ cleanup seemed obvious improvement, wiki now points at most recent release's bin/verilator FAQ.

@veripoolbot
Copy link
Contributor Author

@veripoolbot veripoolbot commented Sep 28, 2019


Original Redmine Comment
Author Name: Todd Strader (@toddstrader)
Original Date: 2019-09-28T22:34:34Z


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.

@veripoolbot
Copy link
Contributor Author

@veripoolbot veripoolbot commented Sep 28, 2019


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2019-09-28T22:58:44Z


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.

@veripoolbot
Copy link
Contributor Author

@veripoolbot veripoolbot commented Sep 29, 2019


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2019-09-29T21:14:23Z


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.

@veripoolbot
Copy link
Contributor Author

@veripoolbot veripoolbot commented Sep 29, 2019


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2019-09-29T21:14:43Z


Sigh. Keeping this open as a reminder.

@veripoolbot
Copy link
Contributor Author

@veripoolbot veripoolbot commented Oct 1, 2019


Original Redmine Comment
Author Name: Todd Strader (@toddstrader)
Original Date: 2019-10-01T10:06:10Z


I've added a blurb in internals.adoc about the CI setup.

@veripoolbot
Copy link
Contributor Author

@veripoolbot veripoolbot commented Oct 1, 2019


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2019-10-01T10:45:58Z


Thanks all.

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.