Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (30 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 1.53 KB

Contributing to SerDes Validation Framework

Thank you for considering contributing to the SerDes Validation Framework! We welcome contributions from the community and are excited to collaborate with you.

How to Contribute

  1. Fork the repository and create a new branch for your feature or bug fix.

    git clone https://github.com/muditbhargava66/serdes-validation-framework.git
cd serdes-validation-framework
git checkout -b feature-or-bugfix-branch

  2. Make your changes. Ensure that your code adheres to the project's coding standards and is well-documented.

  3. Run the tests to make sure your changes do not break existing functionality.

    python -m unittest discover -s tests

  4. Commit your changes and push your branch to your forked repository.

    git add .
git commit -m "Description of your changes"
git push origin feature-or-bugfix-branch

  5. Create a pull request from your branch to the main branch of the original repository. Provide a clear description of your changes and any related issues.

Code of Conduct

Please follow our [Code of Conduct] when contributing.

Reporting Issues

If you encounter any issues or bugs, please open an issue on GitHub and provide as much detail as possible.

Coding Standards

  • Follow the PEP 8 coding style guide for Python code.
  • Write clear, concise, and meaningful commit messages.
  • Ensure that your code is well-documented with comments and docstrings.

Thank you for your contributions!