1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00

Create contributing.md (#1289)

Add a contributing.md file that points new developers towards developer documentation
This commit is contained in:
Leo Vegoda
2023-01-18 08:03:07 -08:00
committed by GitHub
parent 355fff4292
commit d9cd8fe5af

16
contributing.md Normal file
View File

@ -0,0 +1,16 @@
# How to contribute
We welcome volunteer developed code to both fix bugs and add new functionality. We want to keep it as easy as possible to contribute changes. Here are guidelines to help you have a good experience.
## Getting Started
* Our [Getting started](https://docs.peeringdb.com/howto/get-started-developing/) guide has information about how to format your code and our testing and feedback process
* We have a guide on how to set up a [development environment](https://docs.peeringdb.com/howto/run_development_container/)
* You will need a [GitHub account](https://github.com/) to make pull requests
# Additional Resources
* [Django views](https://github.com/peeringdb/peeringdb/blob/master/docs/dev/views.md)
* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
* [PeeringDB Mailing List](https://docs.peeringdb.com/#mailing-lists)