When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
This project was built using Angular CLI. While the built rxjs-uploader library does not depend on Angular, this project does.
Please note we have a code of conduct. Please follow it in all of your interactions with the project.
- Ensure any install or build dependencies are in the proper dependency object in the
package.jsonfile. Additionally, if new peer dependencies have been introduced, add them toprojects/rxjs-uploader/package.json. - Update the README.md with any changes to the public API.
- Increase the version numbers in
package.jsonandprojects/rxjs-uploader/package.jsonand the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer. - Run the test suite (
npm test) to ensure unit tests are still passing. Add unit tests for your added logic as appropriate. - You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
Please conform to our tslint and .stylelintrc files in order to maintain a consistent coding style. We recommend the stylelint VS Code extension for SASS linting.
To build the core module, simply run npm run build in the root of this repository. This will build the module locally to the dist folder. The contents of dist are what eventually gets published to the npm registry.
Run npm start to run the demo application. While running, any changes to either the demo app or the library will trigger a reload, and you'll see your changes live.
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.
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
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.
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.
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.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4