From 2f7872a6bec73c10fc0423b8bab832c645faf15d Mon Sep 17 00:00:00 2001 From: Jeremy Mack Wright Date: Thu, 10 May 2018 00:45:20 -0400 Subject: [PATCH] Filled out developer documentation and added contributing docs. --- CODE_OF_CONDUCT.md | 3 +++ CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++ Tools/package_libraries.py | 42 ----------------------------- docs/developers.md | 54 ++++++++++++++++++++++++++++++++++++++ docs/index.md | 3 ++- 5 files changed, 99 insertions(+), 43 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md delete mode 100644 Tools/package_libraries.py diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a6e63c7 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +It is asked that all contributions to this project be made in a respectful and considerate way. This project has adopted the [Python Community Code of Conduct's](https://www.python.org/psf/codeofconduct/) guidelines. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..146de4e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Introduction + +Thank you for your interest in contributing to the CadQuery Module for FreeCAD. Contributions by the community are welcome and appreciated. + +This guide was created to help get contributors up and running as quickly as possible. Following these guidelines will help ensure that issues get resolved more quickly and efficiently. + +You do not need to be a software developer to have a big impact on this project. Contributions can take many forms including, but not limited to, the following: + +* Writing and improving documentation +* Triaging bugs +* Submitting bugs and feature requests +* Creating tutorial videos and blog posts +* Helping other users get started and solve problems +* Telling others about this project +* Helping with translations and internationalization +* Helping with accessibility +* Contributing bug fixes and new features + +# Code of Conduct +It is asked that all contributions to this project be made in a respectful and considerate way. This project has adopted the [Python Community Code of Conduct's](https://www.python.org/psf/codeofconduct/) guidelines. + +# Technical Guidelines +Beyond being good to one another, there are technical guidelines for contributing to this project as well. + +* Create issues and pull requests for any major changes and enhancements that you wish to contribute back to the project. Discuss things transparently and get community feedback. +* Be welcoming and encouraging to new contributors. Again, see the [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/). + +# First Time Contributors +There is no need to be nervous about making your first contribution. Everybody is a beginner at some point, and there is no better way to learn than just jumping in. If you are not sure what to do, open an [issue](https://github.com/jmwright/cadquery-freecad-module/issues) so that a community member can help you through it. + +# How to Report a Bug +When filing an bug report [issue](https://github.com/jmwright/cadquery-freecad-module/issues), make sure to answer these questions: + +1. What version of the software are you running? +2. What operating system are you running the software on? +3. What are the steps to reproduce the bug? + +# How to Suggest a Feature or Enhancement + +If you find yourself wishing for a feature that does not exist in this module, you are probably not alone. There are bound to be others out there with similar needs. Open a [issue](https://github.com/jmwright/cadquery-freecad-module/issues) which describes the feature you would like to see, why you need it, and how it should work. diff --git a/Tools/package_libraries.py b/Tools/package_libraries.py deleted file mode 100644 index e2289e8..0000000 --- a/Tools/package_libraries.py +++ /dev/null @@ -1,42 +0,0 @@ -""" -Test if the zip file is working. - -Usage: - -- python test_zip_file.py gen -- python test_zip_file.py -""" -import sys -import os -ZIP = os.path.join(os.getcwd(), 'libs.zip') - -if len(sys.argv) == 2 and sys.argv[1] == 'gen': - #--- gen zip file - import jedi, pep8, pyqode, pyqode.core, pyqode.python, pyqode.qt, pygments, frosted, pies, builtins, future, pyflakes, docutils, pint - from qidle.system import embed_package_into_zip - embed_package_into_zip([jedi, pep8, pyqode, pyqode.core, pyqode.python, - pyqode.qt, pygments, pyflakes, builtins, future, docutils, pint, pyparsing], ZIP) -else: - # remove all pyqode path from sys.path (to make sure the package are - # imported from the zip archive) - for pth in list(sys.path): - if 'pyqode' in pth: - print('removing %s' % pth) - sys.path.remove(pth) - - # importing a pyqode module should fail - fail = False - try: - from pyqode.core.api import code_edit - except ImportError: - fail = True - assert fail is True - - # mount zip file - sys.path.insert(0, ZIP) - print(sys.path) - - # test it! - from pyqode.core.api import code_edit - print(code_edit.__file__) - assert ZIP in code_edit.__file__ diff --git a/docs/developers.md b/docs/developers.md index e69de29..f9e1d22 100644 --- a/docs/developers.md +++ b/docs/developers.md @@ -0,0 +1,54 @@ +[