Contributing file

This commit is contained in:
Julien Duponchelle
2015-11-10 12:43:11 +01:00
parent 990cb49854
commit 8282ec1da6

47
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,47 @@
# Contributing to GNS3
We welcome contributions and bugs reports from everyone.
We are friendly don't be afraid to make a mistake.
## Bug reports
Before reporting an issue:
* check on the community forum
* check if an issue is opened on https://github.com/GNS3/gns3-gui
* check if an issue is opened on https://github.com/GNS3/gns3-server
If you are not sure it's a bug ask on community you will get a better
and faster support.
If you are not sure on which project you should report just report the
issue on https://github.com/GNS3/gns3-gui we will make the triage.
## Asking for new features
The best is to start a discussion on the community in order to get feedback
from the whole community.
## Contributing code
We welcome code contribution from everyone including beginners.
Don't be afraid to submit half finished or poor quality we will help you.
Don't hesitate to share your plan before starting working on it, we can help
you to find the way.
### Contributors License Agreements
We at GNS3 are eager to work with you. For small changeslittle bugfixes, correcting typos, and the likeplease 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:
You are willingly licensing your contributions under the terms of the open source license of the project that youre contributing to.
You are legally able to license your contributions as stated.
The reason we do this is to ensure, to the extent possible, that we dont “taint” the projects we manage with contributions that turn out to be improper. This protects everyone who wants to use the projects, including you!
More informations here: https://github.com/GNS3/cla
### Pull request
Pull request is the better way to contributing code. We can easily discuss on the code. Do not hesitate to open the pull request soon in your development in order to get feedback.