Add CONTRIBUTING Guidelines #627
Conversation
- Start with tests for new features - Open draft PR after initial functionality - Refactor, benchmark, and optimize - Offer support for test creation
- 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'
Thanks 😌 |
| - Write unit tests for each new function (if applicable) | ||
| - Add integration tests for end-to-end scenarios | ||
| - Feel free to write temporary unit tests during development if they help you verify functionality | ||
| - These tests can be rough and don't need to be comprehensive - they're just development aids |
There was a problem hiding this comment.
I really like the wording here, it feels welcoming and inclusive!
There was a problem hiding this comment.
we just need some instruction's/help for integration tests, those can be hard to write. This one
Line 119 in 6f2518e
The wav test is a good example to point to I think: https://github.com/RustAudio/rodio/blob/master/tests/wav_test.rs
There was a problem hiding this comment.
took care of it, please take a look let me know what you think
|
off topic, I made a draft for a announcement for the next version of rodio in which we ask for help in improving rodio's API. Let me know if you have any feedback on it: https://github.com/RustAudio/rodio/blob/master/outreach/v0.20_announcement_and_call_for_userstories.md (I should have made it a pr, silly me). You can make a new issue, post the feedback here or even make a pr with changes. Whatever is easiest for you. |
CONTRIBUTING.md
Outdated
| 1. Create a new file in `src/source/` | ||
| 2. Implement the `Source` trait to define how audio samples are generated or modified | ||
| 3. Consider implementing sources like oscillators, noise generators, or effects like amplification, filtering, or distortion | ||
| 4. Begin with a test for your new feature. This approach ensures your PR is ready and simplifies development. Don't worry about optimizing initially; focus on functionality. |
There was a problem hiding this comment.
somewhere in between here we should add:
sources that creates sound get a public (factory) function that constructs the source. This is where you document it. Source that apply effects to other sources get a method with default implementation in the
Sourcetrait, see:src/source/mod.rs. This method should be the only way to apply the effect and is where it is documented.
This is as short as I could get it
|
I added some stuff, github actions bot stole the credit stuff. So now I know what the "maintainers can edit this pr" checkbox does, is makes github steal my credit 😢. edit: kinda fixed it. |
… 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 <[email protected]> Date: Sat Oct 5 02:06:39 2024 +0200
dvdsk
force-pushed
the
add-contributing-guidelines
branch
from
934d14e
to
dd3e8de
Compare
|
we should edit the outreach/announcement <...>.md once this is merged. This might pull some potential contributors over the line. |
- 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
…ownSuperficialNight/rodio into add-contributing-guidelines
- Incorporate Integration Tests contributed by dvdsk - Add leading numbers to bullet points mistakenly commited without numbering
Oof I already made my own version did not realise your version existed so I incorporated yours into mine let me know what u think |
😆
its better then what I had, only feedback I can think of is changing the current And then I think we are done right? |
|
Looks about done, if we can think of anything in the future, we can just make a PR and add it. |
This pull request introduces a CONTRIBUTING guidelines document to assist potential contributors in understanding how to effectively participate in Rodio. By providing guidelines, the is aim to encourage collaboration and ensure that contributions are of higher quality, while also reducing the effort required to understand the codebase.
Next Steps:
Please review the changes and provide any feedback or suggestions for improvement.