Commit c09bfc2c authored by Will Korteland's avatar Will Korteland
Browse files

copy new-repo fluff

parent 1c270be5
Pipeline #213 failed with stage
in 11 seconds
# unix line endings
* text=auto
/target
# build output
target/
# editor backups
*~
# https://hub.docker.com/_/rust?tab=tags
image: "rust/rust:latest"
test:cargo:
script:
- rustc --version && cargo --version # version info for debugging
- cargo test --verbose --jobs 1 --release # don't parallelise - make errors more readable
Before opening a new issue, make sure to search for keywords in the issues
filtered by the "bug" label:
- https://git.korte.land/will/tight/issues?label_name%5B%5D=bug
and verify the issue you're about to submit isn't a duplicate.
Please remove this notice if you're confident your issue isn't a duplicate.
------
## Summary
(Summarise the bug encountered)
## Steps to reproduce
(How one can reproduce the issue)
## What is the current *bug* behavior?
(What actually happens)
## What is the expected *correct* behavior?
(What you should see)
## Relevant logs
(Paste any relevant logs - please use code blocks (```) to format console output,
logs, and code.)
## Possible fixes
(If possible, link to the code that might be responsible for the problem)
/label ~bug
/label ~"To Do"
Before opening a new issue, make sure to search for keywords in the issues
filtered by the "feature" label:
- https://git.korte.land/will/tight/issues?label_name%5B%5D=feature
and verify the issue you're about to submit isn't a duplicate.
Please remove this notice if you're confident your issue isn't a duplicate.
------
## Description
(Include problem, use cases, benefits, and/or goals)
## Proposal
## Links/references
## Documentation blurb
(Write the start of the documentation of this feature here, include:
1. Why should someone use it; the underlying problem
2. The solution
3. How someone uses this
During implementation, this can then be copied and used as a starter for the documentation.)
/label ~"feature"
/label ~"To Do"
Before opening a new issue, make sure to search for keywords in the issues
filtered by the "enhancement" label:
- https://git.korte.land/will/tight/issues?label_name%5B%5D=enhancement
and verify the issue you're about to submit isn't a duplicate.
Please remove this notice if you're confident your issue isn't a duplicate.
------
## Description
(Include problem, use cases, benefits, and/or goals)
## Proposal
## Links/references
## Documentation blurb
(If the enhancement needs documentation, include:
1. The underlying problem.
2. What the solution is.
During implementation, this can then be copied and used as a starter for the documentation.)
/label ~"enhancement"
/label ~"To Do"
## What does this MR do?
## Where should the reviewer start?
## Any background context you want to provide?
## What are the relevant tickets?
## Checklist:
- Does all new code have a test case?
- Does the documentation (including doc comments) need an update?
- Have you updated the Changelog and bumped the version in `Cargo.toml`?
# Changelog
## 0.1.0 (2020-06-04)
* Add repository information
* Initial compiling version
# Contributing to Tight
Pull requests, however trivial, are always welcome. I haven't really got
anything in place yet for handling contributions, so
[send me an email](mailto:will@korteland) and we'll work something out.
This diff is collapsed.
# Tight
Tight is a simple expense tracker, written in Rust. Contributions are
welcome, see [`CONTRIBUTING.md`](CONTRIBUTING.md) for help getting started.
This is in very early stages of development, so I apologise if this
documentation is a bit sparse. I figured sparse would be better than
misleading when I change something fundamental.
## Building
Tight is built with Cargo, the Rust package manager.
Use `cargo build` to compile, and find the resulting binary in
`target/debug/tight`. You can also run `cargo build --release` for a
release build.
## Documentation
Run `cargo doc --open` to open the documentation for both Tight and its
dependencies in a web browser.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment