Skip to content

Commit 3cdb1bc

Browse files
committed
Edit readme and contributing
1 parent 020a6cc commit 3cdb1bc

File tree

2 files changed

+38
-1
lines changed

2 files changed

+38
-1
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
4+
5+
## We Use GitHub Flow
6+
7+
All code changes happen through pull requests, so we recommend GitHub's [GitHub Flow](https://guides.github.com/introduction/flow/). Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
8+
9+
1. **Fork the repo and create your branch from `main`.**
10+
2. **If you've added code that should be tested, add tests.**
11+
3. **Ensure the test suite passes.**
12+
4. **Make sure your code lints.**
13+
5. **Issue that pull request!**
14+
15+
## Any contributions you make will be under the Software License
16+
17+
In short, when you submit code changes, your submissions are understood to be under the same [license](LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern.
18+
19+
## Report bugs using GitHub's issues
20+
21+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](../../issues/new).
22+
23+
## Write bug reports with detail, background, and sample code
24+
25+
**Great Bug Reports** tend to have:
26+
27+
- A quick summary and/or background
28+
- Steps to reproduce
29+
- Be specific!
30+
- Give sample code if you can.
31+
- What you expected would happen
32+
- What actually happens
33+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
34+
35+
## License
36+
37+
By contributing, you agree that your contributions will be licensed under its [license](LICENSE).

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# law-encoder
22

3-
⚖️👨‍⚖️ `️‍️law-encoder` is a Rust library for A-law and μ-law (mu-law) audio encoding. These encoding schemes are defined in ITU-T standards G.711 and are widely used in digital audio processing, particularly in telephony and audio compression.
3+
⚖️`️‍️law-encoder`👨‍⚖ is a Rust library for A-law and μ-law (mu-law) audio encoding. These encoding schemes are defined in ITU-T standards G.711 and are widely used in digital audio processing, particularly in telephony and audio compression.
44

55
## Features
66

0 commit comments

Comments
 (0)