Update to include instructions for checking out tags that addesses submodules

Open
#116 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
git
Domain
documentation

Research direction

No documentation file is named; first inspect the repository's documentation and setup instructions to find where cloning and version checkout are described. Update that guidance to cover recursive submodules when checking out v3.10.0, and verify that the documented commands keep the yara submodule aligned with the tag.

Written by the indexing model from the issue text.

Description

git clone --recursive https://github.com/VirusTotal/yara-python
cd yara-python
git checkout v3.10.0

This would cause yara-python to be at v3.10.0 but its submodule yara would stay at master (which currently happens to be v3.11.0). User should instead use: git checkout --recurse-submodules v3.10.0.

Documentation may want to include this information to prevent any confusion.

Dominant language
C
Stars
754
Forks
190
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from VirusTotal/yara-python

All issues in VirusTotal/yara-python

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.