~wezm/annotate-rust

90739d66833ea90f47f9c3e00ba32b2c475d11f1 — Wesley Moore 6 months ago fe50c75
Add contributing info to the README
1 files changed, 61 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +61 -0
@@ 3,3 3,64 @@
A work in progress Rust annotator for
[git.sr.ht](https://git.sr.ht)'s
[code annotations](https://man.sr.ht/git.sr.ht/annotations.md) feature.

Build
-----

<!--

Build Status:

* Arch Linux: [![builds.sr.ht Arch Linux status](https://builds.sr.ht/~wezm/annotate-rust/arch.yml.svg)](https://builds.sr.ht/~wezm/annotate-rust/arch.yml?)
* Debian: [![builds.sr.ht Debian status](https://builds.sr.ht/~wezm/annotate-rust/debian.yml.svg)](https://builds.sr.ht/~wezm/annotate-rust/debian.yml?)
* FreeBSD: [![builds.sr.ht FreeBSD status](https://builds.sr.ht/~wezm/annotate-rust/freebsd.yml.svg)](https://builds.sr.ht/~wezm/annotate-rust/freebsd.yml?)

-->

To build annotate-rust you will need a [Rust installation][rustup]. Build as
follows:

    git clone https://git.sr.ht/~wezm/annotate-rust && cd annotate-rust
    cargo build --release

The built binary will be in `target/release/annotaterust`.

<!--

Testing
-------

Run the test suite:

    cargo test

-->

Contributing
------------

If you have code or patches you wish to contribute, the preferred mechanism is
a git pull request. Push your changes to a git repository somewhere (Sourcehut,
GitHub, GitLab, whatever). <!--Ensure that contributions don't break [the
tests](#testing) and add new ones when appropriate.-->

Assuming you have followed the [build steps](#build) above you would do the
following to push to your own fork on Sourcehut or your preferred git host:

Change the git URL to match wherever your forked repo is:

    git remote rename origin upstream
    git remote add origin git@git.sr.ht:~yourname/annotate-rust
    git push -u origin master

Then generate the pull request:

    git fetch upstream master
    git request-pull -p upstream/master origin

And copy-paste the result into a plain-text [email to me](mailto:wes@wezm.net).

You may alternately use a patch-based approach as described on
<https://git-send-email.io>.

[rustup]: https://www.rust-lang.org/tools/install