Skip to content

improve instructions #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EED85 merged 1 commit into from
Jul 27, 2025
Merged

improve instructions #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,21 @@

1. In the EED-Solutions organization, create a new repository using this template and assign it a new name, such as `eed_my_new_package`.
2. Create a new branch (e.g., `repo_configuration`).
3. Delete the `uv.lock` file.
4. Update `project.toml` by renaming `eed-package-template` to your new package name (e.g., `eed-my-new-package`).
5. Set up a virtual environment using `uv`.
6. Install pre-commit hooks.
7. Add a note indicating the commit ID from which this repository was created, for example:
3. Rename the directory `src/eed_package_template` to match your new package name (e.g., `src/eed_my_new_package`).
4. Delete the `uv.lock` file.
5. Update `project.toml` by renaming `eed-package-template` to your new package name (e.g., `eed-my-new-package`). set version to ``0.1.0``. Update your decription.
6. Set up a virtual environment using `uv`.
7. Install pre-commit hooks.
8. Update Readme:

Remove section ``## Creating a New Repository from This Template``


Add a note indicating the commit ID from which this repository was created, for example:
```
- created from this template: https://github.com/EED-Solutions/eed_package_template/releases/tag/0.1.0
```
8. Rename the directory `src/eed_package_template` to match your new package name (e.g., `src/eed_my_new_package`).

9. Use VS Code's find and replace feature to update all instances of `eed_package_template` with your new package name.
10. Commit all changes, create a pull request, and ensure all CI pipelines pass.
11. Update repository settings as needed (e.g., import branch/tag rulesets, general settings). For more information, see [this guide](https://eed-solutions.atlassian.net/wiki/x/BIA8Mw) (private access). Rulesets are documented under ``.github\rulesets`` and can be imported.
Expand Down
Loading