Skip to content

Commit b406b38

Browse files
committed
cleanup
1 parent 33b3cc0 commit b406b38

29 files changed

+36334
-0
lines changed

Algebra.js

+4,788
Large diffs are not rendered by default.

BREAKING_CHANGES.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
*version 0.8.0*
2+
- Order of arguments changed for *defint* in `nerdamer.convertToLaTeX`
3+
- `nerdamer.toRPN` not returns array of tokens. Token class can be found in Parser.classes
4+
- The `Operator` class was removed. A simple `object` can be passed to method
5+
- nerdamer.setOperator and nerdamer.getOperators have been deprecated. Use `core.PARSER.setOperator` instead.

CITATION.cff

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
cff-version: 1.2.0
2+
title: "Nerdamer"
3+
message: "If you use this software, please cite it as below.""
4+
version: 1.1.3
5+
date-released: 2021-11-01
6+
url: "https://nerdamer.com"
7+
license: "MIT License"
8+
authors:
9+
- family-names: Donk
10+
given-names: Martin

CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at martin.r.donk@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contributing
2+
Thank you for your interest in contributing to the project. You can submit a pull request at any time with your changes. Please make sure to target the `dev` branch when submitting and not the `master` branch.
3+
4+
Any contribution is welcomed granted the following are performed:
5+
6+
1. Make sure that all unit tests pass. The unit tests are written for **jasmine**. To run the tests, first make sure you install [node.js](https://nodejs.org/en/download/) and [jasmine](https://www.npmjs.com/package/jasmine). Follow the link to install nodejs. You can install jasmine by running `npm install -g jasmine`. Once that's complete you can navigate to your project folder root and type `jasmine`. Please be aware that at the moment, some tests will fail for versions of node.js > 10.xx due to rounding errors.
7+
2. Make sure that there's isn't already an existing solution on the `dev` branch.
8+
9+
Feel free to reach out if you need any guidance navigating the code. Seriously. A slow response doesn't mean you're being ignored but simply that life is in progress. You will however get a response at some point.
10+
11+
# Issues
12+
Please do report any issues you find. If you don't report it, then there's no way of knowing the issue exists in the first place. There are existing issues labeled "Pending issues with xxx". These are just to keep related issues organized. So for instance if you're having a problem with `simplify` you can just add your issue under "Pending issues with simplify". Be sure to mention @jiggzson when reporting.
13+
14+
Give as much information as possible about your issue and try to give it a meaningful subject line. If possible, add an example of what works and what doesn't. If you've already done some debugging, feel free to share since it may help speed up the fix.

0 commit comments

Comments
 (0)