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ο
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
Make your changes. Ensure that your code adheres to the projectβs coding standards and is well-documented.
Run the tests to make sure your changes do not break existing functionality.
python -m unittest discover -s tests
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
Create a pull request from your branch to the
mainbranch 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!