diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c821f5c..46dcccf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,14 +3,14 @@ ## Issues -**Issues** are used to report bugs, problems, feature requests, ask questions or other kind of suggestions. An issue ***should include***: +**Issues** are used to report bugs, problems, feature requests, ask questions, or other suggestions. An issue ***should include***: - Good and meaningful title - Detailed description ### Problems and Bugs -Problem and bug reports ***need also***: +Problem and bug reports ***should also include***: - Expected and actual behaviour - Used version, compiler and platform @@ -34,7 +34,7 @@ The contributed code should match these criteria: - Pass all Unit Tests and CI Builds - Proper Test Cases - Merge cleanly, without conflicts -- Follow the projects code style +- Follow the project's code style - Does not introduce external dependencies - 4 Spaces – no Tabs - UTF-8 encoding @@ -44,4 +44,3 @@ The contributed code should match these criteria: ## Further readings - [Github Guide: How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) - diff --git a/README.md b/README.md index 75fd69e..e87fb69 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Packaging of audio / stem files. -A packages consists of a required master track with `.wav` name and optional stem files (`*.wav`). +A package consists of a required master track with `.wav` name and optional stem files (`*.wav`). If no files are passed, all files found in `Export` are packed. Packed archives are saved to `Export` directory. @@ -29,9 +29,9 @@ trackpack pack project1.wav stem1.wav stem2.wav Use `trackpack --help` for full usage documentation. -### Yaml config format +### YAML config format -The Yaml configuration uses same format as the CLI arguments, but `_` instead of `-`: +The YAML configuration uses the same format as the CLI arguments, but `_` instead of `-`: ```yaml # Required: