You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: {{ cookiecutter.project_slug }}/_manual/contribute/create-feature-request.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ We're excited to hear your ideas! Before you submit a feature request, consider
17
17
18
18
## Your first feature request
19
19
20
-
When you're ready to submit a feature request, use the [feature request template]({{ cookiecutter.repo_url }}/issues/new?template=02-feature_request.md). The template has three sections that help maintainers understand what you need and why.
20
+
When you're ready to submit a feature request, use the [feature request template]({{ cookiecutter.repo_url }}/issues/new?template=02-feature-request.yml). The template has three sections that help maintainers understand what you need and why.
21
21
22
22
<!-- TODO: Put together an example feature request.
Copy file name to clipboardExpand all lines: {{ cookiecutter.project_slug }}/_manual/contribute/git-commit-message.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ parent: Contribute
6
6
---
7
7
## Git Commit Message Format Guide
8
8
9
-
Commits are required to be conventional git commit messages. This helps with the auto-generation of the changelog files and is enforced by pre-commit.
9
+
Commits are required to be conventional git commit messages. This helps with the auto-generation of the changelog files and is enforced by [pre-commit](https://pre-commit.com/).
Copy file name to clipboardExpand all lines: {{ cookiecutter.project_slug }}/_manual/developer-resources/contribute.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,10 +13,10 @@ This page lists resources for developers who want to contribute to the {{ cookie
13
13
### Contribute code to {{ cookiecutter.project_name }}
14
14
15
15
*[Developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %})
16
-
*[Create a pull request] walks you through preparing a clear, descriptive pull request.
16
+
*[Create a pull request]({% raw %}{% link _manual/contribute/create-pull-request.md %}{% endraw %}) walks you through preparing a clear, descriptive pull request.
17
17
*[Create a feature request]({% raw %}{% link _manual/contribute/create-feature-request.md %}{% endraw %})
18
18
*[Merge a pull request]({% raw %}{% link _manual/contribute/merge-pull-request.md %}{% endraw %})
19
-
* Browse all [issues]({{ cookiecutter.repo_url }}/issues/new) to find a good first task. <!-- You can also filter by [help wanted](). -->
19
+
* Browse all [issues]({{ cookiecutter.repo_url }}/issues) to find a good first task. <!-- You can also filter by [help wanted](). -->
20
20
21
21
### Contribute without code
22
22
@@ -26,7 +26,8 @@ This page lists resources for developers who want to contribute to the {{ cookie
26
26
27
27
### Best practices and style
28
28
29
-
Our [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) outline {{ cookiecutter.project_name }} style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding!
30
-
* [Python style guide]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}).
31
-
* [Typescript style guide]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}).
32
-
* [YAML style guide]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}).
29
+
Our [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) outline {{ cookiecutter.project_name }} style for frontend, backend, documentation, and more, including best practices. Please read through them before you start editing or coding!
30
+
31
+
*[Python style guide]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}).
32
+
*[Typescript style guide]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}).
33
+
*[YAML style guide]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}).
Copy file name to clipboardExpand all lines: {{ cookiecutter.project_slug }}/_manual/introduction/getting-started.md
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,18 +9,26 @@ parent: Introduction
9
9
1.[Requirements]({% raw %}{% link _manual/setup-guide/requirements.md %}{% endraw %}) include python3, Nutri-Matic (docs & hooks), rust (rustup), and git-cliff (changelogs).
10
10
* Python3 Packages
11
11
1.[cookiecutter](https://github.com/cookiecutter/cookiecutter) is required to utilize templates from github.
12
-
2. Nutri-Matic is required to be sourced in python environment for template cookiecutter hooks to work.
12
+
2.[Nutri-Matic](https://github.com/jcook3701/nutri-matic) is required to be sourced in python environment for template cookiecutter hooks to work.
13
13
14
14
I find that it easiest to clone the nutri-matic repository. Use the included makefile to install all python dependencies with ```make python-install``` from within the cloned directory. Then, source the created file, ```.venv/bin/activate```, or point the below script variable, ```PYTHON_VENV```, to desired python virtual environment.
15
15
16
-
__Example:__ Bash script can be copied and pasted into a shell file. Then, used to begin generating new projects.
16
+
### Examples
17
+
18
+
Bash script can be copied and pasted into a shell file. Then, used to begin generating new projects.
19
+
17
20
__Template Options:__
18
-
* cookiecutter-cookiecutter to generate new cookiecutter template projects.
19
-
* python3-cookiecutter to generate python3 projects.
20
-
* ansible-cookiecutter to generate ansible galaxy project.
21
+
*[cookiecutter-cookiecutter](https://github.com/jcook3701/cookiecutter-cookiecutter) to generate new cookiecutter template projects.
22
+
*[python3-cookiecutter](https://github.com/jcook3701/python3-cookiecutter) to generate python3 projects.
23
+
*[ansible-cookiecutter](https://github.com/jcook3701/ansible-galaxy-cookiecutter) to generate ansible galaxy project.
24
+
<!-- TODO: The below repositories are planned future work. -->
21
25
<!-- * ansible-config-cookiecutter to generate local ansible configuration. -->
22
-
*typescript-cookiecutter to generate typescript project.
26
+
<!-- * [typescript-cookiecutter](https://github.com/jcook3701/typescript-cookiecutter) to generate typescript project.-->
23
27
<!-- * chrome-extension-cookiecutter to generate google chrome extension project. -->
28
+
<!-- * [ROS2-cookiecutter](https://github.com/jcook3701/ROS2-cookiecutter) to generate Robot2 Operating System Package. -->
29
+
<!-- TODO: Figure out how I want to display documentation templates. -->
30
+
<!-- * [github-docs-cookiecutter](https://github.com/jcook3701/github-docs-cookiecutter) to add documentation to a templates [github pages](https://docs.github.com/en/pages). -->
31
+
<!-- * [sphinx-docs-cookiecutter](https://github.com/jcook3701/sphinx-cookiecutter) to add python documentation generated by [Sphinx](https://github.com/sphinx-doc/sphinx). -->
First clone the nutri-matic python utility. This is needed to clone all jcook3701's, cookiecutter templates, with ```cookiecutter``` command.
9
+
First clone the [Nutri-Matic](https://github.com/jcook3701/nutri-matic) python utility. This is needed to clone all [jcook3701's](https://github.com/jcook3701), cookiecutter templates, with the ```cookiecutter``` command.
Next, create a [virtual environment]({% raw %}{% link _manual/tutorials/create-virtual-env.md %}{% endraw %}) to store nutri-matic install. This is need to avoid installing packages directly to the system python instance.
15
+
Next, move into the newly cloned directory, ```cd nutri-matic``` . Then utilize the [developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %}) process and run ```make python-install```to create a python virtual environment stored within the, ```.venv```, folder. This ensures the latest version of nutri-matic code and is very helpful for development on any of the template repositories.
15
16
16
-
Finally, install [Nutri-Matic](https://github.com/jcook3701/nutri-matic) from [pypi](https://pypi.org/project/nutri-matic/) repository.
17
+
Finally, source Nutri-Matic's created virtual environment with the directory, ```.venv```, and begin generating templates.
17
18
18
19
```shell
19
-
$ python -m pip install nutri-matic
20
+
$ source .venv/bin/active
20
21
```
22
+
23
+
The Nutri-Matic package is responsible for managing all [jcook3701's](https://github.com/jcook3701) cookiecutter template hooks and build features.
24
+
25
+
After the environment is sourced and other project dependencies are installed; templates should be able to be generated using the commands found in our [getting started]({% raw %}{% link _manual/introduction/getting-started.md %}{% endraw %}) guide.
0 commit comments