Merge pull request #24 from KQMATH/develop

v1.0.3

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE/pull_request.md

@@ -0,0 +1,18 @@
+## Description
+A few sentences describing the overall goals of `pull request`
+
+## List of General Components affected
+
+## Status
+- [ ] Ready for Review
+
+## Types of changes
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Non Functional Requirement
+- [ ] Follows the code style of this project.
+- [ ] Tests Cover Changes
+- [ ] All new and existing tests passed.
+- [ ] Documentation

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org).
+
+## [Unreleased]
+
+## [1.0.3] - 2019-01-22
+### Changed
+- Update listing of distributed files in README file.
+
+## 1.0.2 - 2019-01-22
+
+
+[Unreleased]: https://github.com/KQMATH/tex2max/compare/v1.0.3...HEAD
+[1.0.3]: https://github.com/KQMATH/tex2max/compare/v1.0.2...v1.0.3

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+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.
+
+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.
+
+## Scope
+
+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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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.
+
+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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# How to contribute
+
+Thank you for your interest in contributing to the TeX2Max project.
+
+## How can you help?
+
+* Report issues
+* Fix typos and grammar
+* Add new rules
+* Improve existing rules and workflow
+
+## Best practices
+
+- Bugfixes should only contain changes that are related to the purpose of the bug.
+- Description should contain an explanation for the proposed changes.
+- It's recommended to consult feature requests with the team before starting implementation
+- Send us an email if you need assistance with any work. 
+
+## Making changes
+
+* Fork this repository on [GitHub](https://github.com/KQMATH/tex2max).
+* All development work should follow the [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) branching model.
+* Make sure you have added the necessary tests for your changes.
+* If applicable, include a link to the issue in the commit message body.
+
+## Submitting changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the repository in the [KQMATH GitHub organization](https://github.com/KQMATH)
+and choose branch you want to patch (usually develop).
+* Add detail about the change to the pull request including screenshots
+  if the change affects the UI.
+
+## Reviewing changes
+
+* After submitting a pull request, one of TeX2Max team members will review it.
+* Changes may be requested to conform to our style guide and internal
+  requirements.
+* When the changes are approved and all tests are passing, a TeX2Max team
+  member will merge them.
+* Note: if you have write access to the repository, do not directly merge pull
+  requests. Let another team member review your pull request and approve it.
+
+## Style guide
+
+* This repository uses [Markdown](https://daringfireball.net/projects/markdown/) syntax.
+* The preferred spelling of English words is the [American
+  English](https://en.wikipedia.org/wiki/American_English) (e.g. behavior, not
+  behaviour).
+
+## License
+
+By contributing to this repository you agree that all contributions are subject to the 
+GNU General Public License v3.0 under thepublic domain. 
+See [LICENSE](https://github.com/KQMATH/tex2max/blob/master/LICENSE)
+file for more information.
+
+## Review and release process
+
+* Each addition and rule change is discussed and reviewed internally by TeX2Max
+  core team.
+* When contents are updated, [CHANGELOG.md](/CHANGELOG.md) file is updated and a
+  new tag is released. Repository follows [semantic versioning](http://semver.org/).
+* The [official release](https://www.npmjs.com/package/tex2max) at npm must be updated accordingly.

README.md

@@ -8,11 +8,8 @@ TeX2Max supports Node and AMD, in addition to normal browser support.
 ```text
 dist/
 ├── tex2max.amd.js        (AMD)
-├── tex2max.amd.min.js    (AMD, compressed)
 ├── tex2max.js            (UMD)
-├── tex2max.min.js        (UMD, compressed)
-├── tex2max.common.js     (CommonJS, default)
-└── tex2max.common.min.js (CommonJS, compressed)
+└── tex2max.common.js     (CommonJS, default)
 ```
 
 ## Getting started
@@ -98,4 +95,4 @@ npm run build
 ## License
 TeX2Max is Licensed under the [GNU General Public, License Version 3](https://github.com/KQMATH/tex2max/blob/master/LICENSE).
 
-[⬆ back to top](#tex2max)
+[⬆ back to top](#tex2max)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "tex2max",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "LaTeX math to Maxima code converter",
   "main": "dist/tex2max.common.js",
   "unpkg": "dist/tex2max.js",
@@ -13,6 +13,11 @@
     "type": "git",
     "url": "https://github.com/KQMATH/tex2max.git"
   },
+  "keywords": [
+    "latex",
+    "maxima",
+    "converter"
+  ],
   "author": {
     "name": "André Storhaug",
     "email": "[email protected]",