node-mdl-starter
Generated by generator-node-mdl
Why
// TODO
Installation
npm install --save node-mdl-starter
Usage
const nodeMdlStarter = require('node-mdl-starter');
nodeMdlStarter('some text');
//=> some text
Usage
import nodeMdlStarter, { isEven, isOdd } from 'node-mdl-starter';
nodeMdlStarter('some text');
//=> some text
isEven(8);
//=> true
isEven(9);
//=> false
isOdd(8);
//=> false
isOdd(9);
//=> true
If you are not able to use es-modules, you can use require instead of import
const { default: nodeMdlStarter, isEven, isOdd } = require('node-mdl-starter');
To use it directly inside a browser, load it via a script tag:
<script type="text/javascript" src="./node_modules/node-mdl-starter/dist/index.js"></script>
<script type="text/javascript">
const { default: nodeMdlStarter, isEven, isOdd } = window['node-mdl-starter'];
</script>
Related
// TODO
License
MIT © Avi
Examples
There aren‘t any examples yet! Want to add one? See contributing.md
Contributing
Contributions are always welcome, no matter how large or small.
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
Code of Conduct
By participating, you are expected to uphold this Contributor Covenant Code of Conduct. Please report unacceptable behavior to sharvita@gmail.com.
Project setup
First, fork then clone the repo:
git clone https://github.com/your-username/node-mdl-starter
cd node-mdl-starter
git remote add upstream https://github.com/sharvit/node-mdl-starter
Install dependencies:
yarn
Run test suits to validate the project is working:
yarn test
# run test in watch mode
yarn test:watch
Build the project:
yarn build
# only build the dist folder from source
yarn webpack:build
# build webpack with a development mode and watch files
yarn webpack:develop
# only build the docs using esdocs
yarn docs:build
# build docs in watch mode
yarn docs:develop
Run linter to validate the project code:
yarn lint
# to fix linting errors
yarn lint --fix
Run linter to validate your commit message:
yarn lint:commit
Committing and Pushing changes
Create a branch and start hacking:
git checkout -b my-branch
Commit and push your changes:
generator-node-mdl uses commitizen to create commit messages so semantic-release can automatically create releases.
git add .
yarn commit
# answer the questions
git push origin my-branch
Open this project on GitHub, then click “Compare & pull request”.
Help needed
Please checkout the roadmap.md and the open issues.
Also, please watch the repo and respond to questions/bug reports/feature requests, Thanks!
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, gender identity and expression, level of experience, 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 sharvita@gmail.com. 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, version 1.4, available at http://contributor-covenant.org/version/1/4
Project Roadmap
This is where we‘ll define a few things about the library‘s goals.
We haven‘t filled this out yet though. Care to help? See contributing.md