updates to development guidelines #176
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rkdy
previously approved these changes
Dec 4, 2020
joerg-schneider
previously approved these changes
Dec 4, 2020
j-ittner
approved these changes
Dec 4, 2020
sphinx/source/contribution_guide.rst
Outdated
| In order to locally install the package for testing, you can run: | ||
| conda build metadata, build settings and package dependencies | ||
| are obtained from ``meta.yml``. To build and then publish the package to conda, | ||
| use the following commands: | ||
|
|
||
| .. code-block:: RST |
sphinx/source/contribution_guide.rst
Outdated
| @@ -8,7 +8,7 @@ Setup | |||
|
|
|||
| Python environment | |||
| ~~~~~~~~~~~~~~~~~~~~~~ | |||
| There is a ``environment.yml`` provided in the repository root, which installs all | |||
| There is an ``environment.yml`` provided in the repository root, which installs all | |||
| required development dependencies in the ``facet-develop`` environment. | |||
|
|
|||
| .. code-block:: RST | |||
sphinx/source/contribution_guide.rst
Outdated
| and delete the package using | ||
| PyPI project metadata, build settings and package dependencies | ||
| are obtained from ``pyproject.toml``. To build and then publish the package to PyPI, | ||
| use the following commands: | ||
|
|
||
| .. code-block:: RST |
sphinx/source/contribution_guide.rst
Outdated
|
|
||
| **TODO** - once published. | ||
| .. code-block:: RST |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the development guidelines to align with the latest documentation, package build and CI/CD process.