Skip to content

Latest commit

 

History

History
101 lines (59 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

101 lines (59 loc) · 3.96 KB

Contributing to PulsarWave

Thank you for considering contributing to PulsarWave! We appreciate your interest in improving our software and welcome any contributions that help enhance its functionality, usability, or overall quality.

How to Contribute

To contribute to PulsarWave, please follow these general guidelines:

  1. Fork the repository on GitHub to create a copy of the project under your own GitHub account.

  2. Clone your forked repository to your local development environment:

$ git clone https://github.com/sikkha/PulsarWave.git

Create a new branch for your contribution. It's recommended to use a descriptive branch name that reflects the nature of your changes:

$ git checkout -b feature/your-feature

Make the necessary changes or additions to the codebase, documentation, or other project files.

Commit your changes with clear and concise commit messages:

$ git commit -m "Add feature X"

Push your branch to your forked repository:

$ git push origin feature/your-feature

Open a pull request (PR) on the original PulsarWave repository. Provide a clear description of your changes, including the motivation behind them and any relevant details.

Participate in the PR review process, addressing any feedback or suggestions from the maintainers or community members.

Once your changes are approved, they will be merged into the main branch, and your contribution will be acknowledged in the project.

Code Style and Guidelines

To maintain consistency and readability, we follow a set of coding conventions and style guidelines. Please adhere to these guidelines when making contributions to the project. The following guidelines will help ensure code quality and maintainability:

1. Indentation and Formatting

  • Use spaces for indentation, with a consistent indentation size (e.g., 4 spaces).
  • Use meaningful variable and function names to enhance code readability.

2. Comments and Documentation

  • Include comments to explain complex logic, algorithmic choices, or any non-obvious code segments.
  • Document public interfaces and important functions/classes/modules using appropriate docstrings or comments.

3. Code Organization

  • Keep the code modular and well-organized.
  • Separate concerns into functions, classes, and modules.
  • Group related functions or classes together.

4. Error Handling and Exception Handling

  • Properly handle errors and exceptions. Avoid generic exception handling where possible.
  • Provide informative error messages or logging for debugging purposes.

5. Testing

  • Write unit tests to verify the correctness of your code.
  • Ensure that existing tests pass before making changes or adding new features.
  • Write clear, concise, and focused test cases.

6. Version Control and Git Workflow

  • Follow the Git workflow described in the project's documentation.
  • Create a new branch for each feature or bug fix (e.g., feature/your-feature or bugfix/issue-number).
  • Commit atomic changes with clear and descriptive commit messages.

7. Pull Requests and Code Review

  • Submit a pull request (PR) for your changes.
  • Address any feedback or suggestions received during code review promptly.
  • Engage in constructive discussions to improve the quality of the codebase.

Please review and adhere to these guidelines when making contributions to ensure consistency and maintainability across the project.

If you have any questions or need further clarification, feel free to reach out to us in contact listed in MAINTAINERS.

Reporting Issues

If you encounter any bugs, problems, or have suggestions for improvements, please submit an issue on the GitHub issue tracker. Provide as much information as possible, including steps to reproduce the issue and details about your environment. Contact

If you have any questions or need further assistance, feel free to reach out to us in contact listed in MAINTAINERS.

We appreciate your contributions and thank you for helping to make PulsarWave even better!