|
| 1 | +Contributing |
| 2 | +------------ |
| 3 | + |
| 4 | +Please contribute! You can contribute by making a pull request or reporting |
| 5 | +bugs. You can also submit feature requests or ask questions about how to do |
| 6 | +things with wifi. |
| 7 | + |
| 8 | +How to Submit an Issue |
| 9 | +====================== |
| 10 | + |
| 11 | +Issues include bug reports, feature requests, documentation requests, and lots |
| 12 | +of other things too. |
| 13 | + |
| 14 | +1. Go to https://github.com/rockymeza/wifi/issues to see the issue tracker. |
| 15 | + |
| 16 | +2. Please make sure that the issue hasn't already been opened by somebody |
| 17 | + else. |
| 18 | + |
| 19 | +3. Create a New Issue. If it is a bug, please tell me what distro you are |
| 20 | + using. I don't have the capacity to test against a bunch of distros, but I |
| 21 | + do want wifi to work on more than just the one that I use. |
| 22 | + |
| 23 | +How to Submit a Pull Request |
| 24 | +============================ |
| 25 | + |
| 26 | +1. Clone the repo. |
| 27 | + |
| 28 | +2. Run the tests. :: |
| 29 | + |
| 30 | + $ python setup.py test |
| 31 | + |
| 32 | +3. Create a topic branch. |
| 33 | + |
| 34 | +4. Make your awesome changes. |
| 35 | + |
| 36 | + Don't forget to add tests to make sure that your awesome changes will |
| 37 | + continue to work for all of eternity. |
| 38 | + |
| 39 | +5. Make sure that your code conforms to PEP8 and the Zen of Python as much as |
| 40 | + possible (ignore E501, the line lengths requirement). |
| 41 | + |
| 42 | +6. Get on GitHub and submit a pull request. |
| 43 | + |
| 44 | +The best pull requests will not have PEP8 errors and will include tests. If |
| 45 | +you don't have tests, I am still willing to accept the pull request, but it may |
| 46 | +take a while for me to merge it as I would want to write the tests myself and I |
| 47 | +don't have a ton of time I can devote to that (especially during the school |
| 48 | +year). |
0 commit comments