2015-11-10 12:43:11 +01:00
# Contributing to GNS3
We welcome contributions and bugs reports from everyone.
2015-11-14 19:59:15 -07:00
We are friendly so don't be afraid to ask questions.
2015-11-10 12:43:11 +01:00
## Bug reports
Before reporting an issue:
2015-12-10 15:00:16 -07:00
* check our website over at https://gns3.com
2015-11-14 19:59:15 -07:00
* check if an issue already exists on https://github.com/GNS3/gns3-gui
* check if an issue already exists on https://github.com/GNS3/gns3-server
2015-11-10 12:43:11 +01:00
2015-11-14 19:59:15 -07:00
Please post on our community website if you are unsure you found a bug,
you will get faster support and be able to exchange with more users.
2015-11-10 12:43:11 +01:00
2015-11-14 19:59:15 -07:00
If you are unsure which project you should create an issue for, just do
it on https://github.com/GNS3/gns3-gui we will take care of the triage.
2015-11-10 12:43:11 +01:00
2015-11-14 19:59:15 -07:00
For bugs specific to the GNS3 VM, please report on https://github.com/GNS3/gns3-vm
2015-11-10 12:45:22 +01:00
2016-06-13 09:40:23 +02:00
## Security issues
For security issues please keep it private and send an email to developers@gns3 .net
2016-05-18 11:27:38 +02:00
## Asking for new features
2015-11-10 12:43:11 +01:00
2015-11-14 19:59:15 -07:00
The best is to start a discussion on the community website in order to get feedback
2015-11-10 12:43:11 +01:00
from the whole community.
2016-05-18 11:27:38 +02:00
## Contributing code
2015-11-10 12:43:11 +01:00
We welcome code contribution from everyone including beginners.
2015-11-14 19:59:15 -07:00
Don't be afraid to submit a half finished or mediocre contribution and we will help you.
2015-11-10 12:43:11 +01:00
2015-11-14 19:59:15 -07:00
Don't hesitate to share your plans before starting working on a contribution, we can help
you to find the best approach.
2015-11-10 12:43:11 +01:00
### Contributors License Agreements
We at GNS3 are eager to work with you. For small changes — little bugfixes, correcting typos, and the like — please just submit pull requests to any of our projects. For larger changes, though, we have to ask you to jump through a little hoop.
In particular, in order for us to accept any major patches from you, you will have to electronically sign a statement that indicates two things:
2015-11-14 19:59:15 -07:00
- You are willingly licensing your contributions under the terms of the open source license of the project that you’ re contributing to.
- You are legally able to license your contributions as stated.
2015-11-10 12:43:11 +01:00
The reason we do this is to ensure, to the extent possible, that we don’ t “taint” the projects we manage with contributions that turn out to be improper. This protects everyone who wants to use the projects, including you!
2015-11-14 19:59:15 -07:00
More information there: https://github.com/GNS3/cla
2015-11-10 12:43:11 +01:00
2016-05-18 11:27:38 +02:00
### Pull requests
2015-11-10 12:43:11 +01:00
2015-11-14 19:59:15 -07:00
Creating a pull request is the easiest way to contribute code. Do not hesitate to create one early when contributing for new feature in order to get our feedback.