mirror of
https://github.com/Automattic/harper.git
synced 2025-07-07 13:05:01 +00:00
docs: moved contributor documentation to the web
This commit is contained in:
parent
d2a95671aa
commit
9451d01c61
5 changed files with 63 additions and 40 deletions
|
@ -1,41 +1,3 @@
|
|||
# Contributing
|
||||
|
||||
Harper is completely open to outside contributors of any kind.
|
||||
|
||||
If you have a feature request or bug to report, please [create an issue](https://github.com/automattic/harper/issues).
|
||||
|
||||
## Setup Your Environment
|
||||
|
||||
To use the tooling required to build and debug Harper, you'll need to the following programs available in your `PATH`.
|
||||
|
||||
- [`just`](https://github.com/casey/just)
|
||||
- `bash`
|
||||
- [`cargo`](https://www.rust-lang.org/) (we develop against the latest version of Rust)
|
||||
- `yarn`
|
||||
- `node`
|
||||
- `grep`
|
||||
- [`wasm-pack`](https://rustwasm.github.io/wasm-pack/installer/)
|
||||
|
||||
To list out the various tools for development, run:
|
||||
|
||||
```bash
|
||||
just --list
|
||||
```
|
||||
|
||||
I would highly recommend that you run `just setup` to populate your build caches and install the necessary build-tools.
|
||||
|
||||
## Committing
|
||||
|
||||
Harper follows [conventional commit practices](https://www.conventionalcommits.org/en/v1.0.0/).
|
||||
Before creating a pull request, please make sure all your commits follow the linked conventions.
|
||||
|
||||
Additionally, to minimize the labor required to review your commit, we run a relatively strict suite of formatting and linting programs.
|
||||
We highly recommend that you run both `just format` and `just precommit` before submitting a pull request.
|
||||
If those scripts don't work in your environment, we run `just precommit` through GitHub actions inside of pull requests, so you may make modifications and push until the checks pass.
|
||||
|
||||
If this sounds intimidating, don't worry.
|
||||
We are entirely willing to work with you to make sure your code can make it into Harper, just know it might take a little longer.
|
||||
|
||||
## How does it work?
|
||||
|
||||
Please take a read of the [architecture document](./ARCHITECTURE.md).
|
||||
This page has been moved to [the main documentation](https://writewithharper.com/docs/contributors/introduction).
|
||||
|
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: Committing
|
||||
---
|
||||
|
||||
Harper follows [conventional commit practices](https://www.conventionalcommits.org/en/v1.0.0/).
|
||||
Before creating a pull request, please make sure all your commits follow the linked conventions.
|
||||
|
||||
Additionally, to minimize the labor required to review your commit, we run a relatively strict suite of formatting and linting programs.
|
||||
We highly recommend that you run both `just format` and `just precommit` before submitting a pull request.
|
||||
If those scripts don't work in your environment, we run `just precommit` through GitHub actions inside of pull requests, so you may make modifications and push until the checks pass.
|
||||
|
||||
If this sounds intimidating, don't worry.
|
||||
We are entirely willing to work with you to make sure your code can make it into Harper, just know it might take a little longer.
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Set Up Your Environment
|
||||
---
|
||||
|
||||
To use the tooling required to build and debug Harper, you'll need to the following programs available in your `$PATH`.
|
||||
|
||||
- [`just`](https://github.com/casey/just)
|
||||
- `bash`
|
||||
- [`cargo`](https://www.rust-lang.org/) (we develop against the latest version of Rust)
|
||||
- `yarn`
|
||||
- `node`
|
||||
- `grep`
|
||||
- [`wasm-pack`](https://rustwasm.github.io/wasm-pack/installer/)
|
||||
- `zip`
|
||||
|
||||
We develop a series of tools, accessible via `just` to build and debug Harper's algorithm (`harper-core`) and its various integrations.
|
||||
To get see all the tools in your toolbox run:
|
||||
|
||||
```bash
|
||||
just --list
|
||||
```
|
||||
|
||||
Before getting started, I highly recommend that you run `just setup` to populate your build caches and download all dependencies.
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Introduction to Contributing
|
||||
---
|
||||
|
||||
Harper is completely open to outside contributors of any kind.
|
||||
|
||||
If you have a feature request or bug to report, please [create an issue](https://github.com/automattic/harper/issues) and we'll get back to you as soon as we can.
|
||||
|
||||
If you're interested in making a change to the code, we have documentation on [setting up your environment](./environment) and [getting your changes merged in](./committing).
|
|
@ -37,7 +37,6 @@ export default defineConfig({
|
|||
},
|
||||
{
|
||||
title: 'Integrations',
|
||||
to: '/docs/integrations',
|
||||
items: [
|
||||
{
|
||||
title: 'Obsidian',
|
||||
|
@ -68,6 +67,23 @@ export default defineConfig({
|
|||
to: '/docs/integrations/emacs'
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
title: 'Contributors',
|
||||
items: [
|
||||
{
|
||||
title: 'Introduction',
|
||||
to: '/docs/contributors/introduction'
|
||||
},
|
||||
{
|
||||
title: 'Environment',
|
||||
to: '/docs/contributors/environment'
|
||||
},
|
||||
{
|
||||
title: 'Committing',
|
||||
to: '/docs/contributors/committing'
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue