Fix issues with CONTRIBUTING.md #85
Conversation
Improved formatting. Added links in contents to all headings. Fixed some links, and added a few. Fixed some minor grammatical and syntax errors.
There was a problem hiding this comment.
thank you!! this looks a lot cleaner and prettier (and less broken haha).
I've left a few comments for changes I'd like (feel free to debate them with me if you disagree)
Also, can you keep the lines 80char long max? It's easier to work with in many text editors.
| - code of conduct | ||
| - decisions around how we built mathsteps | ||
| - mathJS expression trees | ||
| - [Code of Conduct](#code-of-conduct) |
There was a problem hiding this comment.
these links are great, thanks
|
|
||
| Most of this code iterates over expression trees to make step by step simplifications. We use [mathJS expresison trees](http://mathjs.org/docs/expressions/expression_trees.html#expression-trees), which we recommend you learn a bit about. | ||
|
|
||
| There are a few different types of nodes that show up in the tree. This stepper uses OperationNode, ParenthesisNode, ConstantNode, SymbolNode and FunctionNode. You can also read about them on the [mathJS expressions documentation](http://mathjs.org/docs/expressions/expression_trees.html#nodes). |
There was a problem hiding this comment.
please add the oxford comma after SymbolNode back :p
There was a problem hiding this comment.
Learned something new! 😄
|
|
||
| ### Expression trees in mathJS | ||
|
|
||
| Most of this code iterates over expression trees to make step by step simplifications. We use [mathJS expresison trees](http://mathjs.org/docs/expressions/expression_trees.html#expression-trees), which we recommend you learn a bit about. |
There was a problem hiding this comment.
haha I forgot to add the link! thanks for fixing
| - **Spread the word!** If you think mathsteps is cool, tell your friends! Let them know they can use this and that they can contribute. | ||
| - **Suggest features!** Have an idea for something mathsteps should solve or a way for it to teach math better? If your idea is not an [existing issue](https://github.com/socraticorg/mathsteps/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), create a new issue with the label "enhancement". | ||
| - **Report bugs!** If the bug is not an [existing issue](https://github.com/socraticorg/mathsteps/issues?q=is%3Aopen+is%3Aissue+label%3Abug), create a new issue with the label "bug" and provide as many details as you can, so that someone else can reproduce it. | ||
| - **Contribute code!** We'd love to have more contributors working on this. Check out the section below with more information on how to contribute, and feel free to mail us at mathsteps@socratic.org with any questions! |
|
|
||
| ### Testing | ||
| - If you want to work on something, please comment on the [related issue](https://github.com/socraticorg/mathsteps/issues) on GitHub before you get started, so others are aware that you're working on it. In case there's is no existing issue for the change you'd like to make, you can [create a new issue](https://github.com/socraticorg/mathsteps/issues/new). |
There was a problem hiding this comment.
"In case there's" -> "In the case that there's"
(or "If there's no existing...")
|
Just to make things clear, in the above commits I've only made changes to CONTRIBUTING.md, and merged the commits that were pushed to |
|
Can you get the rest of the changes out of the diff by merging in master? The same issue happened in #68 and merging master seemed to fix it. |
|
I made a gist for what I think the file should look like with the 80 char max https://gist.github.com/evykassirer/a3c10666b9c7e7232abe478204521422 Mainly, I think it's better to not have line breaks between sentences and stuff. This is based off of what I've seen for markdown files, but I'm definitely not an expert on this and if you think what you have is nicer I'm open to conversation. Content looks 👌 woo Thanks for dealing with my pickiness ^__^ I'm very grateful for this changes and excited to have a nicer thing for new contributors to read :D |
|
Done! 😌 |
|
perfect, the merge commit worked :) thanks for your patience and for this change! wooo 🎉 |
With these changes, I have:
This closes issue #86.