Skip to content

Commit

Permalink
misc: adds contributing file
Browse files Browse the repository at this point in the history
  • Loading branch information
m1dugh committed Nov 5, 2023
1 parent ad5a038 commit c6b2b47
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

This project is meant to evolve over time be community contributions.
Feel free to open a Pull Request or an issue to discuss any change or
enhancement.

## How to contribute.

1. Open an issue on the topic you want to discuss about
- Don't forget to add tags, it will be easier to understand the purpose of
the issue ;).

2. If you can, fork the repo, make the changes, and create a pull request.
3. Test if it builds and works. Unit tests may be added later on.
4. Don't forget documentation !

## Notes

Any change to the code must respect the coding style.

An `.eslintrc.yml` file is provided at the root of the repo to format the
typescript code.

A `.clang-format` file is provided in the `cppsrc/` folder to format the code.

Any change is welcome !
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,9 @@ DeviceType.ALL; // device type is both input and output
-----

## Contributing
As an open-source project, every one is free to modify the codebase. Feel free to open any discussion or issue or PR to improve this project.
See [CONTRIBUTING.md](https://github.com/romlm/native-sound-mixer/blob/master/CONTRIBUTING.md)

-----

## License
This project is under [MIT](https://github.com/romlm/native-sound-mixer/blob/develop/LICENSE) license
This project is under [MIT](https://github.com/romlm/native-sound-mixer/blob/master/LICENSE) license

0 comments on commit c6b2b47

Please sign in to comment.