diff --git a/Getting-Involved.md b/Getting-Involved.md new file mode 100644 index 0000000..3aecbbf --- /dev/null +++ b/Getting-Involved.md @@ -0,0 +1,27 @@ +Would you like to help contribute to NetBox's development? There are plenty of ways you can help out! + +### Code Contributions + +The most direct way of contributing to NetBox is helping out with bug reports and feature development. NetBox is a pretty busy project, and there's always a backlog of issues just waiting for someone to volunteer. These can be quickly identified by searching for issues with [the "needs owner" tag](https://github.com/netbox-community/netbox/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+needs+owner%22). Just be sure to review our [contributing policy](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md) first, then comment on any issues you'd like to take on and a maintainer will assign it to you. + +Here are some other resources to help you get started: + +* [NetBox development docs](https://netbox.readthedocs.io/en/stable/development/) +* [NetBox live coding](https://www.youtube.com/channel/UCyTz3NglyCnIAhvEgat41sQ) sessions by **@jeremystretch** +* [Django documentation](https://docs.djangoproject.com/en/stable/) +* Free IDEs: [JetBrains PyCharm](https://www.jetbrains.com/pycharm/), [Microsoft Visual Studio Code](https://code.visualstudio.com/) + +### Documentation + +Coding not your thing? Don't worry, you can still contribute to NetBox's extensive [written documentation](https://netbox.readthedocs.io/en/stable/). It seems like there are always at least a couple [documentation issues](https://github.com/netbox-community/netbox/issues?q=is%3Aissue+is%3Aopen+label%3A%22type%3A+documentation%22) hanging around for a volunteer to snag, but you're also welcome to propose new changes or additions. + +Our documentation is written using [Markdown](https://guides.github.com/features/mastering-markdown/) for markup, which is pretty common and super easy to pick up. + +### Community Involvement + +NetBox has a very active community of users around the world, and there are always ample opportunities to help out. Our discussion takes place primarily across two forums. + +* [GitHub Discussions](https://github.com/netbox-community/netbox/discussions) - Discussion forum +* **#netbox** on [NetDev Slack](https://netdev.chat/) - Live chat + +Just have a look through the most recent conversations, and you'll be sure to stumble across someone who you could a helping hand. Or, maybe you'd like to share your own tips & tricks. We'd love to hear from you!