Commit graph

13 commits

Author SHA1 Message Date
David Kleingeld
02933d4adf
Point to rustdoc book in CONTRIBUTING.md
Specifically request contributors to take a look at the documenting a component section.
2024-10-08 00:53:26 +02:00
UnknownSuperficialNight
ab66761e91 Rename Testing to Unit Tests 2024-10-06 15:38:31 +13:00
UnknownSuperficialNight
0aa7f5e703 Merge: Integrate 'Integration Tests' from user dvdsk
- Incorporate Integration Tests contributed by dvdsk
- Add leading numbers to bullet points mistakenly commited without numbering
2024-10-05 15:24:58 +13:00
UnknownSuperficialNight
417d5a10b3 Merge branch 'add-contributing-guidelines' of https://github.com/UnknownSuperficialNight/rodio into add-contributing-guidelines 2024-10-05 15:09:10 +13:00
UnknownSuperficialNight
d57e410ca7 Add Contributing guide and Integration Test guidelines
- Link to CONTRIBUTING.md in project root
- New Integration Tests section:
  - Avoid sound output in tests
  - Tips for testing audio sources
  - Suggest examples for audible features
  - Note challenges in automated audio testing
2024-10-05 15:06:27 +13:00
github-actions[bot]
dd3e8de93a
Contributing.md adds section on integration tests, improve new source section
Specifically notes some example tests and how they test. Also mentions
sometimes you just have to listen, recommends adding example for that.

Author:    dvdsk <noreply@davidsk.dev>
Date:      Sat Oct 5 02:06:39 2024 +0200
2024-10-05 02:34:44 +02:00
UnknownSuperficialNight
b6a90594aa Remove 'Ensure code quality' 2024-10-05 02:34:56 +13:00
UnknownSuperficialNight
dc85fe8045 Update testing guidelines in CONTRIBUTING.md
- Encourage use of temporary unit tests during development
- Clarify that rough, non-comprehensive tests are acceptable
- Allow inclusion of temporary tests in pull requests
- Explain rationale for removing tests before final merge:
  - Easier refactoring
  - Reduced necessity due to Rust's type system
- Maintain instruction to run tests with 'cargo test'
2024-10-05 02:32:13 +13:00
UnknownSuperficialNight
41db8554fb Add guidelines for TDD, PR workflow, and optimization
- Start with tests for new features
- Open draft PR after initial functionality
- Refactor, benchmark, and optimize
- Offer support for test creation
2024-10-05 00:10:37 +13:00
UnknownSuperficialNight
c19faddd32 Add 'Useful External Resources' Section 2024-10-04 23:56:03 +13:00
UnknownSuperficialNight
400dfe5a6e Add Rust performance book mention 2024-10-04 23:52:22 +13:00
UnknownSuperficialNight
c0066f9445 Updates a few changes 2024-10-04 17:07:38 +13:00
UnknownSuperficialNight
8c9f2faa00 Init commit of CONTRIBUTING.md 2024-10-04 16:39:30 +13:00