Contributing Guidelines
© 2025 Maktab-e-Digital Systems Lahore
Licensed under the Apache 2.0 License.
Thank you for your interest in contributing to the CAN Bus IP Core Project!
We welcome all contributions, including bug reports, feature requests, code improvements, and documentation updates.
Reporting Issues
If you find a bug or have a suggestion:
- Check existing issues before opening a new one to avoid duplicates.
- Create a new issue using the issue template and include:
- A clear title and description
- Steps to reproduce the issue (if applicable)
- Expected and actual behavior
- Screenshots, simulation logs, or waveform captures (if relevant)
👉 Report issues here: GitHub Issues
Submitting Pull Requests (PRs)
We encourage you to contribute code or documentation through pull requests.
Steps to submit a PR:
- Fork the repository and create your branch:
bash git checkout -b feature/your-feature-name - Test your changes (simulation, synthesis, or documentation build).
- Commit with a clear message:
bash git commit -m "Add: implemented CRC check logic in CAN receiver" - Push your branch:
bash git push origin feature/your-feature-name - Open a Pull Request and describe your changes clearly.
Include: - Purpose of the change
- Test results or simulation screenshots
- Any related issue numbers
Code Review Process
Every pull request will be reviewed for:
- Code readability and compliance with standards
- Correct functionality and simulation results
- Proper documentation and comments
Once approved, the PR will be merged into the main branch.
Issue Labels and Priorities
We use labels to organize and prioritize issues in the CAN Bus IP Core project.
| Label | Description | Priority |
|---|---|---|
| bug | A verified issue causing incorrect CAN functionality or simulation failure. | High |
| enhancement | Suggestion for performance optimization or feature addition (e.g., new error detection logic). | Medium |
| documentation | Improvements or corrections to user guides, theory of operation, or register map documentation. | Low |
| help wanted | Issues open for community contribution or beginner-friendly fixes. | Medium |
| critical | Severe issue causing design malfunction, synthesis failure, or data corruption. | Urgent |
| testing | Tasks related to simulation, verification, or waveform analysis. | Medium |
| discussion | Open topic for design decisions, architectural improvements, or brainstorming. | Low |
Licensed under the Apache License 2.0
Copyright © 2025
Maktab-e-Digital Systems Lahore