Skip to content

Improve some minor spelling issues #318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
offa merged 1 commit into from
Oct 10, 2026
Merged

Improve some minor spelling issues #318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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/)

6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

Packaging of audio / stem files.

A packages consists of a required master track with `<prject name>.wav` name and optional stem files (`*.wav`).
A package consists of a required master track with `<project name>.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.
Expand All @@ -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:
Expand Down
Loading