generated from litestar-org/project-template
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md.jinja
66 lines (50 loc) · 8.56 KB
/
README.md.jinja
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# {{project_name}}
<div align="center">
| Project | | Status |
| --------- | :-- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| CI/CD | | [](https://github.com/jolt-org/{{project_name}}/actions/workflows/publish.yaml) [](https://github.com/jolt-org/{{project_name}}/actions/workflows/ci.yaml) [](https://github.com/jolt-org/{{project_name}}/actions/workflows/docs.yaml) |
| Quality | | [](https://sonarcloud.io/summary/new_code?id=jolt-org_{{project_name}}) [](https://sonarcloud.io/summary/new_code?id=jolt-org_{{project_name}}) [](https://sonarcloud.io/summary/new_code?id=jolt-org_{{project_name}}) [](https://sonarcloud.io/summary/new_code?id=jolt-org_{{project_name}}) [](https://sonarcloud.io/summary/new_code?id=jolt-org_{{project_name}}) |
| Community | | [](https://discord.gg/XpFNTjjtTK) |
| Meta | | [](https://github.com/jolt-org/) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/jolt-org) [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black) |
</div>
## About
This project is a template repository for [Jolt][jolt-org] projects. It is designed to be a starting point for
any project that is a part of the Jolt organization.
## Usage
- [Install copier](https://copier.readthedocs.io/en/stable/#installation)
- `$ copier copy gh:jolt-org/project-template $new-project-name`
- Answer questions.
## New project checklist
- [ ] Create the https://github.com/jolt-org/{{project_name}} repository.
- [ ] If using docs: Create the https://github.com/jolt-org/{{project_name}}-docs-preview repository.
- [ ] If not using docs: remove `.github/workflows/docs-preview.yaml`.
- [ ] Update the [README.md](README.md) file with the project-specific information.
- [ ] Initialize git repository: `$ git init`
- [ ] Stage the files: `$ git add ."`
- [ ] Install pre-commit hooks: `$ pre-commit install`
- [ ] Run pre-commit hooks: `$ pre-commit run --all-files`
- [ ] Stage any files that were modified by the pre-commit hooks: `$ git add .`
- [ ] Commit the changes: `$ git commit -m "Initial commit"`
- [ ] Add the remote: `$ git remote add origin git@github.com:jolt-org/{{project_name}}.git`
- [ ] Push the changes: `$ git push -u origin main`
## Contributing
All [Jolt][jolt-org] projects will always be a community-centered, available for contributions of any size.
Before contributing, please review the [contribution guide][contributing].
If you have any questions, reach out to us on [Discord][discord], our org-wide [GitHub discussions][jolt-discussions] page,
or the [project-specific GitHub discussions page][project-discussions].
<hr>
<!-- markdownlint-disable -->
<p align="center">
<!-- github-banner-start -->
<img src="https://raw.githubusercontent.com/jolt-org/meta/2901c9c5c5895a83fbfa56944c33bca287f88d42/branding/SVG%20-%20Transparent/logo-full-wide.svg" alt="Litestar Logo - Light" width="20%" height="auto" />
<br>A <a href="https://github.com/jolt-org">Jolt Organization</a> Project
<!-- github-banner-end -->
</p>
[jolt-org]: https://github.com/jolt-org
[contributing]: https://docs.{{project_name}}.jolt.rs/latest/contribution-guide.html
[discord]: https://discord.gg/XpFNTjjtTK
[jolt-discussions]: https://github.com/orgs/jolt-org/discussions
[project-discussions]: https://github.com/jolt-org/{{project_name}}/discussions
[project-docs]: https://docs.{{project_name}}.jolt.rs
[install-guide]: https://docs.{{project_name}}.jolt.rs/latest/#installation
[newrepo]: https://github.com/organizations/jolt-org/repositories/new?template={{project_name}}