Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#815)
Browse files Browse the repository at this point in the history
  • Loading branch information
ellie authored Mar 26, 2023
1 parent c4e68cc commit c64674d
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,40 @@
# Contributing

Firstly, thank you so much for considering contributing to Atuin!
Thank you so much for considering contributing to Atuin! We really appreciate it <3

Atuin doesn't require anything super special to develop - standard Rust tooling will do you just fine. We commit to supporting the latest stable version of Rust - nothing more, nothing less, no nightly.

Before working on anything, we suggest taking a copy of your Atuin data directory (`~/.local/share/atuin` on most \*nix platforms). If anything goes wrong, you can always restore it!

## Setup

```
git clone https://github.com/ellie/atuin
cd atuin
cargo build
```

## Running

When iterating on a feature, it's useful to use `cargo run`

For example, if working on a search feature

```
cargo run -- search --a-new-flag
```

While iterating on the server, I find it helpful to run a new user on my system, with `sync_server` set to be `localhost`.

## Tests

Our test coverage is currently not the best, but we are working on it! Generally tests live in the file next to the functionality they are testing, and are executed just with `cargo test`.


## Migrations

Be careful creating database migrations - once your database has migrated ahead of current stable, there is no going back

### Stickers

We try to ship anyone contributing to Atuin a sticker! Only contributors get a shiny one. Fill out [this form](https://notionforms.io/forms/contributors-stickers) if you'd like one.

1 comment on commit c64674d

@vercel
Copy link

@vercel vercel bot commented on c64674d Mar 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

atuin – ./

atuin-ellieh.vercel.app
atuin-git-main-ellieh.vercel.app
atuin.sh

Please sign in to comment.