Skip to content

Latest commit

 

History

History
31 lines (16 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

31 lines (16 loc) · 1.46 KB
Raw

How to contribute to ChampSim

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

  • If possible, use the relevant bug report templates to create the issue.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in the Discussions section and start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about the source code?

  • Ask any question about how to use ChampSim in the Discussions section.

Do you want to contribute to the ChampSim documentation?

  • Please submit a pull request that modifies documentation sources in the docs/ directory

ChampSim is a volunteer effort. We encourage you to pitch in and join!