Skip to content

vshard: contribution short guide #2756

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
TarantoolBot opened this issue Mar 16, 2022 · 1 comment
Closed

vshard: contribution short guide #2756

TarantoolBot opened this issue Mar 16, 2022 · 1 comment
Assignees
Labels
contributor ramp up vshard [area] Related to vshard module

Comments

@TarantoolBot
Copy link
Collaborator

TarantoolBot commented Mar 16, 2022

Product: modules
Since:
Audience/target:
Root document: https://www.tarantool.io/en/doc/latest/contributing/contributing/#how-to-contribute-to-modules
SME: @ Gerold103

Details

The guide copypaste from README:


In order to contribute you might want to avoid installation into regular paths.
You need to fetch the source code to patch it in a local folder.

  • git clone <this repo or your fork>;
  • git submodule update --init --recursive;
  • VShard requires Tarantool being in PATH. So either you install one into the
    system or you fetch Tarantool's main repository source code, build it, and
    add to PATH manually these paths: <path to tarantool build>/src and
    <path to tarantool build>/extra.

Now vshard should be functional. You can try it in example folder, see its
Makefile.

Your patch should pass all the existing tests (unless it is necessary to change
them) and have its own test usually. To run the tests this should work:

  • cd test;
  • python test-run.py or ./test-run.py;
@Gerold103 Gerold103 changed the title installation instructions for contributing to vshard module vshard: contribution short guide Mar 16, 2022
@patiencedaur patiencedaur added vshard [area] Related to vshard module contributor ramp up labels Mar 21, 2022
@veod32
Copy link
Collaborator

veod32 commented Mar 29, 2022

Discussed and decided that it's not a good idea to duplicate the same content in two different places. In this case, the content becomes out of synch eventually. It's better to keep this guide in the repository readme.

@veod32 veod32 closed this as completed Mar 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor ramp up vshard [area] Related to vshard module
Projects
None yet
Development

No branches or pull requests

3 participants