Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

68 lines (48 loc) · 1.96 KB

Contributing

License

By contributing to this project, you agree that your contributions will be licensed under the project's license (MIT OR Apache-2.0).

Thank you for your contribution!

Looking for issues?

https://github.com/Gifted-s/bd/issues

NOTE

Please note that the code in v2 is the most recent (not experimental) and under active development, the src modules are for the experimental version

How do I contribute

Fork the project and use the git clone command to download the repository to your computer. A standard procedure for working on an issue would be to:

  1. Clone the velarixdb repository and download it to your computer.

    git clone https://github.com/Gifted-s/velarixdb

  2. Pull all changes from the upstream main branch, before creating a new branch - to ensure that your main branch is up-to-date with the latest changes:

    git pull

  3. Create a new branch from main like: bugfix-232-ensure-compaction-runs-within-time-frame-allocated:

    git checkout -b "[the name of your branch]"

  4. Make changes to the code, and ensure all code changes are formatted correctly:

    cargo fmt

  5. Ensure all clippy rules are obeyed:

    cargo clippy --tests

  6. Ensure nothing is unexpectedly broken:

    cargo test

  7. Commit your changes when finished:

    git add -A
git commit -m "[your commit message]"

  8. Push changes to GitHub:

    git push origin "[the name of your branch]"

  9. Submit your changes for review, by going to your repository on GitHub and clicking the Compare & pull request button.

  10. Ensure that you have entered a commit message which details the changes, and what the pull request is for.

  11. Now submit the pull request by clicking the Create pull request button.

  12. Wait for code review and approval.

  13. After approval, your pull request will be merged.