Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 4.46 KB

CONTRIBUTING.md

File metadata and controls

77 lines (55 loc) · 4.46 KB

Contributing to audio-waveform

Thank you for considering contributing to audio-waveform! We welcome and appreciate all contributions from the community.

Before getting started, please take a moment to review our code of conduct and contribution guidelines:

Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.

Examples of unacceptable behavior by participants include:

The use of sexualized language or imagery Personal attacks Trolling or insulting/derogatory comments Public or private harassment Publishing others' private information, such as physical or electronic addresses, without explicit permission Other unethical or unprofessional conduct Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

Contribution Guidelines

Thank you for considering contributing to this project! Please take a moment to review the guidelines below.

Code Style

Please follow the code style guidelines for this project. These guidelines can be found in the README file.

Reporting Issues

If you find any issues or bugs in the project, please submit a new issue on the project repository. When submitting an issue, please provide as much detail as possible, including steps to reproduce the issue, the expected behavior, and the actual behavior.

Pull Requests

We welcome all pull requests from the community! Before submitting a pull request, please make sure your changes adhere to the following guidelines:

Your code should follow the code style guidelines for this project. All new and existing tests should pass. Any documentation that requires updates should be updated. If your pull request fixes an issue, please reference the issue number in your commit message or pull request description. Once you have submitted a pull request, the project maintainers will review your changes and provide feedback. If your changes are accepted, they will be merged into the project.

Thank you for your interest in contributing to this project!

Report Issues

If you find any issues or bugs in audio-waveform, please let us know by submitting a new issue on our GitHub repository. When submitting an issue, please provide as much detail as possible, including steps to reproduce the issue, the expected behavior, and the actual behavior.

Fix Bugs

If you have identified a bug and would like to fix it, please follow these steps:

Fork the repository Create a new branch for your changes Make the necessary changes and test thoroughly Submit a pull request with your changes Add New Features If you have an idea for a new feature that you would like to add to audio-waveform, please follow these steps:

Fork the repository Create a new branch for your changes Implement the new feature and test thoroughly Submit a pull request with your changes Improve Documentation If you notice any errors or inconsistencies in the project documentation, please let us know by submitting a new issue or pull request.

Help with Testing

We welcome all help with testing audio-waveform. If you are interested in helping with testing, please follow these steps:

Fork the repository

Create a new branch for your changes Implement any necessary changes to the test suite Submit a pull request with your changes Provide Feedback We are always open to feedback from the community. If you have any feedback, suggestions, or ideas for improving audio-waveform, please let us know by submitting a new issue or pull request.

Thank you for your interest in contributing to audio-waveform. We look forward to working with you!