Skip to content

Commit e88f9e3

Browse files
committed
first commit
0 parents  commit e88f9e3

12 files changed

Lines changed: 2117 additions & 0 deletions

File tree

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/target
2+
3+
# REPL
4+
repl.history

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# 🔗 How to contribute
2+
Every help is welcome! See how to contribute below
3+
4+
# Starting
5+
1. Fork this project on Github
6+
2. Make a clone of the created fork repository: `git clone https://github.com/youruser/rustbase-cli.git`
7+
3. Create a branch to commit your feature or fix: `git checkout -b my-branch`
8+
4. And make your changes!
9+
10+
## Unit tests
11+
If are you creating a new feature, make sure to create a unit tests to it. To make a unit tests, add the following code in the same file of you feature:
12+
```rust
13+
// Unit tests
14+
#[cfg(test)]
15+
mod your_feature_tests {
16+
#[test]
17+
fn testing_feature() {
18+
...
19+
}
20+
}
21+
```
22+
23+
### Running unit tests
24+
To run a unit test use: `cargo test`
25+
26+
See more about unit tests [here](https://doc.rust-lang.org/rust-by-example/testing/unit_testing.html)
27+
28+
## Commit messages
29+
We suggest that commit messages follow the *conventional commit*.
30+
31+
See about *conventional commit* [here](https://www.conventionalcommits.org/en/v1.0.0/)
32+
33+
# When you're done, make your Pull Request!
34+
* Commit your changes
35+
* Push your branch to your fork: `git push origin my-branch`
36+
* Go to Pull Requests from the root repository and create a [Pull Request](https://github.com/rustbase/rustbase-cli/pulls) with your commit(s)

0 commit comments

Comments
 (0)