Browse Source

Documentation

bernhardbuhl 4 years ago
parent
commit
c40f88c739
3 changed files with 33 additions and 1 deletions
  1. 0 1
      .gitignore
  2. 3 0
      docs/Developer.rst
  3. 30 0
      docs/contributors.rst

+ 0 - 1
.gitignore

@@ -7,5 +7,4 @@ geckodriver.log
 *.png
 baangt.ini
 /Screenshots
-/docs/_build
 /docs/logs

+ 3 - 0
docs/Developer.rst

@@ -30,6 +30,9 @@ Instead create a subclass of BrowserDriver
 That's it. Business people will love you and whenever "specialThingForThisClient" changes, you'll have to adjust only
 in one place.
 
+After subclassing you'll need to replace the standard ``BrowserHandling`` with ``MyCustomBrowser`` in order for baangt
+to use it.
+
 Plugins
 -------
 

+ 30 - 0
docs/contributors.rst

@@ -0,0 +1,30 @@
+Contributions
+=============
+
+Ways to contribute:
+    * Documentation
+    * Bugfixing
+    * New features
+
+Documentation
+-------------
+
+The documentation of ``baangt`` is written in RST-Format and part of the standard repository. The compiled documentation
+from Sphinx is in the same repository in the branch ``gh-pages``.
+
+    * Make sure you have the latest version checked out in GIT
+    * Create a branch with your name
+    * Create a pull request
+
+Bugfixing
+---------
+
+If you found a bug and want to fix it, please describe the bug in the issue tracker and create a branch with the bug number. Then create a Pull request.
+
+New features
+------------
+
+Before you fork please get in contact and let's discuss, if the new feature you have in mind should go into ``baangt``
+standard functionality.
+
+