Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,20 @@ This project supports all versions of Python through until end of life. The deve

To ensure the `--quiet` flag is always effective, avoid using simple `print` statements. Instead, use the purpose-built `usethis._console.plain_print` function.

### Branding

The usethis name should not be capitalized (i.e. not Usethis or UseThis), even at the
beginning of a sentence. It should only be styled in monospace as `usethis` when referring to the command itself.

These colours are used in branding materials:

- Green: #00c000
- Orange: #f26622
- Grey: #999999
- Darker Grey: #424242

Along with the fonts [EB Garamond](https://fonts.google.com/specimen/EB+Garamond) and [Cairo](https://fonts.google.com/specimen/Cairo).

## Guides

### Adding a new badge
Expand All @@ -108,3 +122,7 @@ To add a new `usethis badge` interface, follow these steps:
- Declare a recommended badge placement in the `get_badge_order` function in <src\usethis\_core\badge.py>. This helps ensure the badges are arranged in an opinionated way relative to existing badges.

Finally, run the command on this project, to make sure the badge gets inserted correctly with valid Markdown syntax. Check it renders successfully and that any hyperlink works as expected.

## License

By contributing, you agree that your contributions will be licensed under the MIT license. See the [LICENSE](https://github.com/usethis-python/usethis-python/blob/main/LICENSE) file.
5 changes: 5 additions & 0 deletions docs/about-license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# License

usethis is licensed under the MIT license ([LICENSE](https://github.com/usethis-python/usethis-python/blob/main/LICENSE) or <https://opensource.org/licenses/MIT>)

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in usethis by you, as defined in the Apache License, Version 2.0, (<https://www.apache.org/licenses/LICENSE-2.0>), shall be licensed under the MIT license, without any additional terms or conditions.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ nav:
- Reference: cli/reference.md
- Similar Projects: similar-projects.md
- FAQ: faq.md
- License: about-license.md

theme:
name: material
Expand Down
1 change: 1 addition & 0 deletions tests/docs/test_readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ def test_assemble_readme_from_docs(usethis_dev_dir: Path):
)
)
parts.append(_get_doc_file(usethis_dev_dir / "docs" / "similar-projects.md"))
parts.append(_get_doc_file(usethis_dev_dir / "docs" / "about-license.md"))

content = (
(usethis_dev_dir / "README.md")
Expand Down
2 changes: 1 addition & 1 deletion tests/usethis/_tool/impl/test_ruff.py
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ def test_pyproject_toml_exists(self, tmp_path: Path):
@pytest.mark.usefixtures("_vary_network_conn")
def test_latest_version(self, tmp_path: Path):
if os.getenv("CI"):
pytest.skip("Avoid flaky pipelines by testing version bumps manually")
pytest.skip("Avoid flaky pipelines by testing version bumps manually")

with change_cwd(tmp_path), files_manager():
# Arrange
Expand Down