Skip to content

Commit

Permalink
Improve & Move "How to contribute" section to Top level readme (p4lan…
Browse files Browse the repository at this point in the history
…g#4580)

* Moved "How to contribute" section

Moved "How to contribute" section to Top level readme for better organization

* [Docs] linked Contribution Guidelines

* [Docs] Improve Guideline description

* [Docs] Added Reporting issue section

- Added reporting issue section 
- Improved content placement

* [Docs] Removed Contribution Guides and added Link to CONTRIBUTING.md

* [Refactor] Heading of "How to Contribute"

* [Docs] Add learning Resources and Communication channels

* Docs: Improve Description for "How to Contribute"

* Docs: Fix Spelling of source

* Refactor: Link for Compiler Design pdf
  • Loading branch information
AdarshRawat1 authored Apr 3, 2024
1 parent 7b62006 commit 7da595b
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -625,3 +625,29 @@ access them from the IR
* Tables with multiple apply calls

See also [unsupported P4_16 language features](backends/bmv2/README.md#unsupported-p4_16-language-features).

# How to Contribute

We welcome and appreciate new contributions. Please take a moment to review our [Contribution Guidelines](CONTRIBUTING.md) to get started.

# P4 Compiler Onboarding
Educational material on P4:

- General hands-on [tutorials](https://github.com/p4lang/tutorials).
- [Technical documentation on P4-related topics](https://github.com/jafingerhut/p4-guide?tab=readme-ov-file#introduction).
- Motivating P4: [IEEE ICC 2018 // Keynote: Nick McKeown, Programmable Forwarding Planes Are Here To Stay](https://www.youtube.com/watch?v=8ie0FcsN07U)
- Introducing P4-16 in detail:
- Part 1: [Introduction to P4_16. Part 1](https://www.youtube.com/watch?v=GslseT4hY1w)
- Part 2: [Introduction to P4_16. Part 2](https://www.youtube.com/watch?v=yqxpypXIOtQ)
- Material on the official P4 compiler:
- [Understanding the Open-Source P4-16 Compiler - February 15, 2022 - Mihai Budiu](https://www.youtube.com/watch?v=Rx5AQ0IF6eU)
- [Understanding P4-16 Open-Source Compiler, Part 2 - March 1, 2022 - Mihai Budiu](https://www.youtube.com/watch?v=YnPHPaPSmpU)
- [Compiler Design - Implementation Architecture](https://github.com/p4lang/p4c/blob/main/docs/compiler-design.pdf).
- Introduction to P4Runtime: [Next-Gen SDN Tutorial - Session 1: P4 and P4Runtime Basics](https://www.youtube.com/watch?v=KRx92qSLgo4)

# Contact
We appreciate your contributions and look forward to working with you to improve the P4 Compiler Project (p4c)!
- For further assistance or questions regarding contributions, reach out to us in our [community chat](https://p4-lang.slack.com/). [Joining link](https://join.slack.com/t/p4-lang/shared_invite/zt-a9pe96br-Th73ueaBAwJw1ZbD_z1Rpg) .
- For general P4-related questions, use the [P4 forum](https://forum.p4.org/).
- For other communication channels click [here](https://p4.org/join/).

8 changes: 0 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,6 @@ p4c

* Check out the [IntelliJ P4 plugin](https://github.com/TakeshiTseng/IntelliJ-P4-Plugin)

# How to contribute

* do write unit test code
* code has to be reviewed before it is merged
* make sure all tests pass when you send a pull request
* make sure `make cpplint` produces no errors (`make check` will also run this)
* write documentation

# Writing documentation

Documenting the workings of the compiler is a never-ending (many times
Expand Down

0 comments on commit 7da595b

Please sign in to comment.