Thank you for considering contributing to the P4 Compiler Project (P4C)! Your contributions are valuable and help improve the project for everyone. Before getting started, please take a moment to review the following guidelines.
The P4 organizations uses DCO for contributions. Please take a look at our guidelines.
To sign off the last commit quickly use the git commit --amend --signoff command. The failing check will also include instructions on how to sign off all commits in two steps (using git rebase HEAD~$NUM_COMMITS --signoff). The Developer Community DCO guide also provides helpful tips on fixing DCO inconveniences. Setting up a commit hook in the P4C repository will automate adding the DCO signoff.
Please note that this project adheres to the P4 Coding Standard Philosophy. By participating, you are expected to uphold this code.
We welcome and appreciate new contributions. Check out git usage to get started.
- Writing unit test code Guidelines.
- Write documentation Guidelines.
- Coding conventions.
- Opening pull requests and writing commit messages Guidelines.
- Code has to be reviewed before it is merged.
- Make sure all tests pass when you send a pull request.
- Participate in the code review process and address any feedback or comments.
- Make sure
cmake --build . --target clang-format cpplint black isortproduces no errors.
- Check out the issues that have specifically been marked as being friendly to new contributors
- Have a look at this README. Can it be improved? Do you see typos? You can open a PR.
If you encounter any issues or have suggestions for improvement, please open an issue with a clear description and, if possible, steps to reproduce.
We welcome feature requests! Please open an issue and provide as much detail as possible about the requested feature and its use case.
Happy coding!