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
Thanks for your interest in Harlequin! Harlequin is primarily maintained by [Ted Conbeer](https://github.com/tconbeer), but he welcomes all contributions.
4
+
5
+
## Sponsoring Harlequin
6
+
7
+
Please consider [sponsoring Harlequin's author](https://github.com/sponsors/tconbeer), so he can continue to dedicate time to Harlequin.
8
+
9
+
## Providing Feedback
10
+
11
+
Ted would love to hear from you!
12
+
13
+
-[Create a New Discussion](https://github.com/tconbeer/harlequin/discussions/new/choose) to request new features, get troubleshooting support, or say hello.
14
+
-[Open an Issue](https://github.com/tconbeer/harlequin/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=) to report bugs (Please use the bug template!).
15
+
16
+
## Contributing Documentation
17
+
18
+
Code for the [harlequin.sh](https://harlequin.sh/) website is hosted in the [`harlequin-web`](https://github.com/tconbeer/harlequin-web) repo. The docs are all written in Markdown, which makes them easy to update. Please open PRs against that repo if our docs can be improved.
19
+
20
+
## Contributing Code
21
+
22
+
We aim to create a welcoming and inclusive environment for new contributors, whether this is your first open-source contribution or your 1,000th. Please see the [Contributing Guide](https://harlequin.sh/docs/contributing/index) for detailed instructions on local development and testing, including an end-to-end walkthrough [video](https://www.tella.tv/video/cls3nmne700000gl4bcp91arr/view).
23
+
24
+
## Creating an Adapter
25
+
26
+
In addition to contributing to Harlequin core, you can contribute to one of Harlequin's many [adapters](https://harlequin.sh/docs/adapters), or create your own. There is a [guide to creating an adapter](https://harlequin.sh/docs/contributing/adapter-guide) on the Harlequin website.
Copy file name to clipboardexpand all lines: README.md
+5-18
Original file line number
Diff line number
Diff line change
@@ -65,25 +65,12 @@ COLOR, KEY BINDING, OR COPY-PASTE PROBLEMS? See [Troubleshooting](https://harleq
65
65
66
66
Visit [harlequin.sh](https://harlequin.sh) for an overview of features and full documentation.
67
67
68
-
## Contributing
69
-
70
-
Thanks for your interest in Harlequin! Harlequin is primarily maintained by [Ted Conbeer](https://github.com/tconbeer), but he welcomes all contributions and is looking for additional maintainers!
71
-
72
-
### Providing Feedback
68
+
## Sponsoring Harlequin
73
69
74
-
We'd love to hear from you! [Open an Issue](https://github.com/tconbeer/harlequin/issues/new) to request new features, report bugs, or say hello.
70
+
Please consider [sponsoring Harlequin's author](https://github.com/sponsors/tconbeer), so he can continue to dedicate time to Harlequin.
75
71
76
-
### Setting up Your Dev Environment and Running Tests
77
-
78
-
1. Install Poetry v1.2 or higher if you don't have it already. You may also need or want pyenv, make, and gcc.
79
-
1. Fork this repo, and then clone the fork into a directory (let's call it `harlequin`), then `cd harlequin`.
80
-
1. Use `poetry install --sync` to install the project (editable) and its dependencies (including all test and dev dependencies) into a new virtual env.
81
-
1. Use `poetry shell` to spawn a subshell.
82
-
1. Type `make` to run all tests and linters, or run `pytest`, `black .`, `ruff . --fix`, and `mypy` individually.
72
+
## Contributing
83
73
84
-
### Opening PRs
74
+
Thanks for your interest in Harlequin! Harlequin is primarily maintained by [Ted Conbeer](https://github.com/tconbeer), but he welcomes all contributions!
85
75
86
-
1. PRs should be motivated by an open issue. If there isn't already an issue describing the feature or bug, [open one](https://github.com/tconbeer/harlequin/issues/new). Do this before you write code, so you don't waste time on something that won't get merged.
87
-
2. Ideally new features and bug fixes would be tested, to prevent future regressions. Textual provides a test harness that we use to test features of Harlequin. You can find some examples in the `tests` directory of this project. Please include a test in your PR, but if you can't figure it out, open a PR to ask for help.
88
-
2. Open a PR from your fork to the `main` branch of `tconbeer/harlequin`. In the PR description, link to the open issue, and then write a few sentences about **why** you wrote the code you did: explain your design, etc.
89
-
3. Ted may ask you to make changes, or he may make them for you. Don't take this the wrong way -- he values your contributions, but he knows this isn't your job, either, so if it's faster for him, he may push a commit to your branch or create a new branch from your commits.
76
+
Please see [`CONTRIBUTING.md`](./CONTRIBUTING.md) for more information.
0 commit comments