Skip to content

Latest commit

 

History

History
31 lines (18 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

31 lines (18 loc) · 1.9 KB
Raw

Contributing

First of all, thank you for considering contributing to this project ❤️. We appreciate your effort and time in making OSS better.

We'll help to set up the environment, explain needed parts of the code, discuss implementation, and review the code.

Workflow

  1. Fork the repo: https://github.com/TheBestTvarynka/Dataans/fork.
  2. Set up local development environment: TheBestTvarynka/Dataans#development.
  3. Make changes and commit them to your development branch.
  4. Push commits to your repo.
  5. Create a pull request with a proper title and description.

Commit messages

We don't have a strict style guide for the commit messages. Your pull request will be squashed and merged anyway. The only restriction we have is our CODE_OF_CONDUCT.md. Please, follow this policy 😊.

Code style

  1. Run cargo +nightly fmt --all periodically.
  2. Additionally, refer to the STYLE.md document to read about the code style guidelines.

What to contribute?

If you want to implement a missing/wanting feature, then create a discussion, discuss it with maintainer(s), get approval, and start working on it.

If you want to fix a bug, then create an issue/discussion, discuss possible solutions with maintainer(s), get approval, and start fixing it.

If you don't know what to implement, then you can browse existing issues or ask for help in the discussions. We always have something to do 😜.