HowToGetInvolved: Difference between revisions
No edit summary |
(Add section on Documentation) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
* Chat with us on our [https://chat.gnuradio.org Matrix Server] (or using our [[ | * Chat with us on our [https://chat.gnuradio.org Matrix Server] (or using our [[Chat|IRC Bridge]]) | ||
* Participate on the [[MailingLists|mailing list]] | * Participate on the [[MailingLists|mailing list]] | ||
* Read this wiki and contribute back. Some pages that need constant attention are the [[FAQ]] and the [[Tutorials]]. | * Read this wiki and contribute back. Some pages that need constant attention are the [[FAQ]] and the [[Tutorials]]. | ||
| Line 7: | Line 7: | ||
* Find small bugs and fix them, or help fix known bugs posted to our [https://github.com/gnuradio/gnuradio/issues Github Issues page]. | * Find small bugs and fix them, or help fix known bugs posted to our [https://github.com/gnuradio/gnuradio/issues Github Issues page]. | ||
* Test [https://github.com/gnuradio/gnuradio/pulls Pull Requests] people have submitted, and provide feedback/input. | * Test [https://github.com/gnuradio/gnuradio/pulls Pull Requests] people have submitted, and provide feedback/input. | ||
* We have a [[Calendar]] containing monthly [[DevelopersCalls|developer calls]] and other events | |||
== Coding and debugging == | == Coding and debugging == | ||
| Line 21: | Line 22: | ||
* Browse through the GitHub issues and PRs within the main [https://github.com/gnuradio/gnuradio git repo] | * Browse through the GitHub issues and PRs within the main [https://github.com/gnuradio/gnuradio git repo] | ||
* Write QA code and provide example flowgraphs where they are missing | * Write QA code and provide example flowgraphs where they are missing | ||
== Documentation == | |||
Without documentation, the GNU Radio toolkit would be very difficult to learn and use. There are many areas where the documentation can be completed and expanded. | |||
=== Block docs === | |||
In GNU Radio, a block is a functional item which processes data. Currently there are more than 480 blocks. The [https://wiki.gnuradio.org/index.php/Category:Block_Docs Block Docs] index has a page for each block, describing it's function and use. Many of the block pages have incomplete information, needing example flowgraphs, links to the source code, and other items. | |||
=== Tutorials === | |||
There are many good [[Tutorials]] for beginner level through advanced developers. However, new releases of the GNU Radio code may impact details in the existing tutorials. So the tutorials need review and updating as new software is released. Additional tutorials are also helpful. | |||
=== How to get started === | |||
* Although anyone can edit the Wiki, if you are going to do much work on it, you should get a Wiki account. At the top right of any of the wiki pages (including this one), click on "Request account" and fill in the fields. It may take a day or two for a moderator to approve you. | |||
* Learn to use [https://www.mediawiki.org/wiki/MediaWiki MediaWiki] (the markup language for the wiki). | |||
* Choose a block which needs work and update it! | |||
Latest revision as of 17:31, 15 October 2022
- Chat with us on our Matrix Server (or using our IRC Bridge)
- Participate on the mailing list
- Read this wiki and contribute back. Some pages that need constant attention are the FAQ and the Tutorials.
- When you're learning stuff, write a tutorial and put it up here
- Promote GNU Radio at your workplace, university etc.
- Become a mentor for the Google Summer of Code
- Find small bugs and fix them, or help fix known bugs posted to our Github Issues page.
- Test Pull Requests people have submitted, and provide feedback/input.
- We have a Calendar containing monthly developer calls and other events
Coding and debugging
Of course, the majority of work comes from the people who contribute code. If you want to help here, you can contribute your own code, or help us debug the existing code, take care of bit-rot etc.
Your Own Code
Anything you write using GNU Radio might be of interest! If you've written software, libs or even tutorials, tell us about it on the mailing list, publish the code on the web (e.g. on github) and link it on CGRAN .
GNU Radio Core Code
- Definitely read the contributor guide
- Browse through the GitHub issues and PRs within the main git repo
- Write QA code and provide example flowgraphs where they are missing
Documentation
Without documentation, the GNU Radio toolkit would be very difficult to learn and use. There are many areas where the documentation can be completed and expanded.
Block docs
In GNU Radio, a block is a functional item which processes data. Currently there are more than 480 blocks. The Block Docs index has a page for each block, describing it's function and use. Many of the block pages have incomplete information, needing example flowgraphs, links to the source code, and other items.
Tutorials
There are many good Tutorials for beginner level through advanced developers. However, new releases of the GNU Radio code may impact details in the existing tutorials. So the tutorials need review and updating as new software is released. Additional tutorials are also helpful.
How to get started
- Although anyone can edit the Wiki, if you are going to do much work on it, you should get a Wiki account. At the top right of any of the wiki pages (including this one), click on "Request account" and fill in the fields. It may take a day or two for a moderator to approve you.
- Learn to use MediaWiki (the markup language for the wiki).
- Choose a block which needs work and update it!