From 4aba2c05a7fe4b5350d91acd8c89658629a03fd4 Mon Sep 17 00:00:00 2001 From: "Vinicius D. Cerutti" <51954708+viniciusdc@users.noreply.github.com> Date: Tue, 16 Jan 2024 10:35:13 -0300 Subject: [PATCH] Expand installation notes & update good-first-issues link (#400) --- docs/docs/community/code-contributions.mdx | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/docs/community/code-contributions.mdx b/docs/docs/community/code-contributions.mdx index ab6a78b65..7be7c7739 100644 --- a/docs/docs/community/code-contributions.mdx +++ b/docs/docs/community/code-contributions.mdx @@ -16,10 +16,8 @@ To contribute to the documentation, read [Contribute to Nebari's documentation][ ## Select an issue to work on - - New to Nebari? -The issues marked with the "good first issue" label are an excellent place to start. +The issues marked with the ["good first issue"][good-first-issue] label are an excellent place to start. These bug reports and feature requests have a low entry-barrier, need little historical context, and are self-contained. Select a "good first issue" that matches your interest and skill set. @@ -110,6 +108,10 @@ python -m pip install -e .\[dev\] ``` ::: +:::note +If you encounter the following issue while attempting to install the development version of Nebari `AssertionError: Error getting the version from source vcs`, make sure that all tags were also pulled and synced with your forked git repository (`git fetch --tags upstream`), as Nebari heavily depends on those tags as a source to build its development and production versions dynamically. +::: + ### Pre-commit hooks The `nebari` repository uses [pre-commit hooks](https://pre-commit.com/) to keep the code format consistent across the codebase. @@ -248,6 +250,7 @@ Approval means the core team member has carefully reviewed the changes, and the [nebari-repo]: https://github.com/nebari-dev/nebari [nebari-docs-repo]: https://github.com/nebari-dev/nebari-docs [nebari-docs]: https://www.nebari.dev/ +[good-first-issue]: https://github.com/nebari-dev/nebari/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22