m2n037 / awesome-mecheng

Awesome Mechanical Engineering Resources
GNU General Public License v3.0
1.1k stars 206 forks source link

CAD and other stuffs #30

Closed Clockmaker closed 6 years ago

Clockmaker commented 6 years ago

Closes #29 Lots of commits, but they are mostly undo/reverts/various errors.

I used @pwab 's suggestion and added a collapsible ToC and "Back to Top" links

Other stuff:

A note on ISBN style:

I personally like it, not much to say; if you dislike it, I can revert it back. The html is this:

&emsp;&bull; <sub><sup>ISBN: 978-1439802472</sup></sub>

To sum it up, the list needs a style's guideline.

pwab commented 6 years ago

Just a little tip: You can add a closes #xyz into your PR ~title~ body which will automatically close the corresponding issue when the PR is merged. (Also works with fix and resolve)

~Example for the title: CAD and other stuffs - Closes #29~

Further reference: https://github.com/blog/1506-closing-issues-via-pull-requests

Clockmaker commented 6 years ago

thank you for the tip!

killing &bull; is a matter of seconds; refactoring <sub><sup> is the real annoying part. So i guess it's somewhat fine, for now...

pwab commented 6 years ago

Argh I was telling nonsense - you have to include it into the body of your PR...

All you have to do is include the special keyword syntax (eg. "fixes #5") in the body of your Pull Request.

So the title can stay as it was but only the body must include the signal word combined with the issue reference.

Sorry :sweat_smile:

Clockmaker commented 6 years ago

No problem