Skip to content

Commit 5323f0b

Browse files
author
ioannam
committed
Updated documentation
1 parent ed86e63 commit 5323f0b

File tree

5 files changed

+86
-97
lines changed

5 files changed

+86
-97
lines changed

AUTHORS.md

-4
This file was deleted.

CONTRIBUTING.md

-57
This file was deleted.

docs/devguide.rst

+67-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,70 @@
22
Developer Guide
33
***************
44

5-
To be added.
5+
6+
Contributions
7+
===============
8+
9+
Before contributing code:
10+
11+
* Fork [the repository](https://github.com/compas-dev/compas_slicer) and clone the fork.
12+
13+
* Install compas_slicer from your local forked copy:
14+
15+
.. code-block:: bash
16+
17+
pip install -e .
18+
19+
* Install development dependencies:
20+
21+
.. code-block:: bash
22+
23+
pip install -r requirements-dev.txt
24+
25+
* BEFORE you start working on your updates, make sure all tests pass:
26+
27+
.. code-block:: bash
28+
29+
invoke test
30+
31+
* BEFORE you start working on your updates, make sure you pass flake8 tests.
32+
33+
.. code-block:: bash
34+
35+
invoke lint
36+
37+
* Now you can add your code in the appropriate folder. If you are not sure where to put it, contact `@ioannaMitropoulou <https://github.com/ioannaMitropoulou>`_.
38+
39+
* Add an example in the examples folder that uses the new functionality. Run the example and ensure it works smoothly.
40+
41+
* Add your name to the authors in README.md.
42+
43+
* Make sure again that all tests pass, and that flake8 is also happy!
44+
45+
* Create a [pull request](https://help.github.com/articles/about-pull-requests/) for the master branch, where you explain in detail what you fixed. When you create a pull request, there is an automatic action that runs the tests for your code again on the server. Make sure the pull request passes the automatic tests as well. If not, inspect the result, find what went wrong, fix it, and push the result again to your branch. The action will run again automatically on the open pull request.
46+
47+
48+
During development, use [pyinvoke](http://docs.pyinvoke.org/) tasks on the
49+
command line to ease recurring operations:
50+
51+
* `invoke clean`: Clean all generated artifacts.
52+
* `invoke check`: Run various code and documentation style checks.
53+
* `invoke docs`: Generate documentation.
54+
* `invoke test`: Run all tests and checks in one swift command.
55+
* `invoke`: Show available tasks.
56+
57+
58+
Increase version
59+
===================
60+
61+
To increase the version of compas_slicer, do the following:
62+
63+
* Push all your changes to the main branch and make sure that your local copy is on the main branch and has no updates.
64+
65+
* Use the command 'release' with the options major / minor / patch
66+
67+
.. code-block:: bash
68+
69+
invoke release patch
70+
71+
This automatically pushes the new changes to pip. Conda forge will pick it up and in a few hours you will receive an email. Approve the PR request and then the updated version also goes to conda.

docs/installation.rst

+18-33
Original file line numberDiff line numberDiff line change
@@ -72,39 +72,6 @@ with the following command:
7272
Enjoy!
7373

7474

75-
76-
Contributions
77-
===============
78-
79-
Before contributing code:
80-
81-
- Install development dependencies:
82-
83-
.. code-block:: bash
84-
pip install -r requirements-dev.txt
85-
86-
- Make sure all tests pass:
87-
.. code-block:: bash
88-
invoke test
89-
90-
- Make sure you pass flake8 tests. (hint: This is the most annoying part of the process)
91-
.. code-block:: bash
92-
invoke lint
93-
94-
- Add your code in the appropriate folder. If you are not sure where to put it, contact [@ioannaMitropoulou](https://github.com/ioannaMitropoulou).
95-
96-
97-
- Add an example on the examples folder that uses the new functionality. Run the example and make sure it works smoothly.
98-
99-
100-
- Add your name to the authors in README.md.
101-
102-
103-
- Create a pull request for the master branch, where you explain in detail what you fixed. When you create a pull request, there is an automatic action that runs the tests for your code again on the server.
104-
Make sure the pull request passes the automatic tests as well. If not, then inspect the result, find what went wrong, fix it, and push again the result on your branch. The action will run again automatically on the open pull request.
105-
106-
107-
10875
Troubleshooting
10976
===============
11077

@@ -170,3 +137,21 @@ by typing the following command (make sure you are in the correct environment)
170137
171138
conda install -c conda-forge networkx=2.5
172139
140+
141+
142+
Bug reports
143+
===========
144+
145+
When `reporting a bug <https://github.com/compas-dev/compas_slicer/issues>`_, please include:
146+
147+
- Operating system name and version.
148+
- Any details about your local setup that might be helpful in troubleshooting.
149+
- Detailed steps to reproduce the bug.
150+
151+
Feature requests
152+
================
153+
154+
When `proposing a new feature <https://github.com/compas-dev/compas_slicer/issues>`_, please include:
155+
156+
- Explain in detail how it would work.
157+
- Keep the scope as narrow as possible, to make it easier to implement.

requirements.txt

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,4 @@ numpy<=1.23.2
55
progressbar2>=3.53,<4.4
66
pyclipper>=1.2.0,<1.3.0
77
rdp==0.8
8-
libigl>=2.4.1,<2.5.0
9-
p
8+
libigl>=2.4.1,<2.5.0

0 commit comments

Comments
 (0)