chore: added documentation on how to get started contributing to the …

…project

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Submitting Issues
+
+We use GitHub issues to track public bugs. If you are submitting a bug, please provide
+as much info as possible to make it easier to reproduce the issue and update unit tests.
+
+# Contributing Code
+
+This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).
+
+We follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html) so all contributions happen through pull requests. We actively welcome your pull requests:
+
+1.  Fork the repo and create your branch from master.
+2.  If you've added code that should be tested, add tests.
+3.  If you've changed APIs, update the documentation.
+4.  Ensure the test suite passes.
+5.  Issue that pull request!
+
+When submitting code changes your submissions are understood to be under the same MIT License that covers the project. Feel free to contact Eyevinn Technology if that's a concern.
+
+# 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. 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

README.md

@@ -91,6 +91,68 @@ and this means that it is not possible to mix muxed TS with demuxed CMAF.
 
 A breaking change was introduced in v3.4.0 when Typescript types were introduced. The library no longer exports a default. This means that you need to change `const ChannelEngine = require('eyevinn-channel-engine')` to `const { ChannelEngine } = require('eyevinn-channel-engine')`;
 
+## Contributing
+
+Read [CONTRIBUTING](CONTRIBUTING.md) first and then follow the instructions below to get started with the devolpment environment.
+
+### Development
+
+Ensure that you are running node version 16 as version 18 is not supported yet.
+
+```
+node --version
+v16.17.0
+```
+
+Then install the dependencies:
+
+```
+npm install
+```
+
+Build the app:
+
+```
+npm run build
+```
+
+To start the reference implementation in `server.ts` run:
+
+```
+npm start
+```
+
+For full debug mode you set the environment variable `DEBUG`.
+
+```
+DEBUG=* npm start
+```
+
+or if you want be more specific for example:
+
+```
+DEBUG=engine-* npm start
+```
+
+In addition there other reference implemetations that can be used:
+- `server-demux.ts` : example with demuxed audio
+- `server-livemix.ts` : example with live mimxing
+- `server-multicodec.ts` : example with multicodec
+
+### Source linking hls-vodtolive library
+
+It is not uncommon that you need to test an local branch of the hls-vodtolive library and in order to do that you can use `npm link`.
+
+1. Go to the directory where you have the source code for the hls-vodtolive library and run `npm link`
+2. Then go to the channel engine source code directory and run `npm link @eyevinn/hls-vodtolive`
+
+To restore and use the npm published version run the following in the channel engine source code directory:
+
+```
+npm uninstall --no-save @eyevinn/hls-vodtolive
+npm install
+```
+
 ## Support
 
 Join our [community on Slack](http://slack.streamingtech.se) where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you: