CONTRIBUTING.md

🔗 How to contribute

Every help is welcome! See how to contribute below

Starting

1. Fork this project on Github
2. Make a clone of the created fork repository: git clone https://github.com/youruser/dustdata.git
3. Create a branch to commit your feature or fix: git checkout -b my-branch
4. And make your changes!

Unit tests

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:

// Unit tests
#[cfg(test)]
mod your_feature_tests {
    #[test]
    fn testing_feature() {
        ...
    }
}

Running unit tests

See more about unit tests here

Commit messages

We suggest that commit messages follow the conventional commit.

See about conventional commit here

When you're done, make your Pull Request!

• Commit your changes
• Push your branch to your fork: git push origin my-branch
• Go to Pull Requests from the root repository and create a Pull Request with your commit(s)