Skip to content

Latest commit

 

History

History
160 lines (111 loc) · 5.99 KB

CONTRIBUTING.rst

File metadata and controls

160 lines (111 loc) · 5.99 KB
Raw

Contributing guide

Thanks for your interest in contributing to cpplint.

Any kinds of contributions are welcome: Bug reports, Documentation, Patches.

However cpplint is a bit special as a project because it aims to closely follow what Google does in the upstream repository. That means Google remains the source of all major requirements and functionality of cpplint, where as this fork adds extensions to cpplint run on more environments and in more companies. The difference between this cpplint and Google should remain so small that anyone can at a glance see there is no added change that could be regarded as a security vulnerability.

Here are some tips to make best use of your time:

  1. Feature suggestions should initially be opened at the upstream repository, but feel free to open an issue here to and link to the upstream issue.
  2. Consider the goals and non-goals of this project:

Goals:

  • Provides cpplint as a PyPI package for multiple python versions
  • Add a few features and fixes aimed at usages outside Google

Non-Goals:

  • Become an independent fork adding major features
  • Fix python style issues in cpplint

Development

For many tasks, it is okay to just develop using a single installed python version. But if you need to test/debug the project in multiple python versions, you need to install those versions:

  1. (Optional) Install multiple python versions

    1. (Optional) Install [pyenv](https://github.com/pyenv/pyenv-installer) to manage python versions

    2. (Optional) Using pyenv, install the python versions used in testing:

      pyenv install 2.7.16
pyenv install 3.6.8
# ...
pyenv local 2.7.16 3.6.8 ...

It may be okay to run and test python against locally installed libraries, but if you need to have a consistent build, it is recommended to manage your environment using virtualenv: [virtualenv](https://virtualenv.pypa.io/en/latest/ ), [virtualenvwrapper](https://pypi.org/project/virtualenvwrapper/ ):

  1. (Optional) Setup a local virtual environment with all necessary tools and libraries:

    mkvirtualenv cpplint [-p /usr/bin/python3]
pip install .[dev]

Alternatively you can locally install patches like this:

pip install -e .[dev]
# for usage without virtualenv, add --user

You can setup your local environment for developing patches for cpplint like this:

# run a single test
pytest --no-cov cpplint_unittest.py -k testExclude
# run a single CLI integration test
pytest --no-cov cpplint_clitest.py -k testSillySample
# run all tests
./setup.py test
./setup.py lint
./setup.py style
./setup.py ci # all the above
tox    # all of the above in all python environments

Releasing

The release process first prepares the documentation, then publishes to testpypi to verify, then releases to real pypi. Testpypi acts like real pypi, so broken releases cannot be deleted. For a typical bugfixing release, no special issue on testpypi is expected (but it's still good practice).

To release a new version:

# prepare files for release
vi cpplint.py # increment the version
vi changelog.rst # log changes
git add cpplint.py changelog.rst
git commit -m "Releasing x.y.z"
# test-release (on env by mkvirtualenv -p /usr/bin/python3)
pip install --upgrade setuptools wheel twine
rm -rf dist
# Test release, requires account on testpypi
python3 setup.py sdist bdist_wheel
twine upload --repository testpypi dist/*
# ... Check website and downloads from https://test.pypi.org/project/cpplint/
# Actual release
twine upload dist/*
git tag x.y.z
git push --tags

After releasing, it is be good practice to comment on github for closed tickets, to notify authors.

Catching up with Upstream

For maintainers, it is a regular duty to look at what cpplint changes were merged upstream, to include them in this fork (though these updates happen once per year and less).

Checkout here and upstream google:

git clone [email protected]:cpplint/cpplint.git
cd cpplint
git remote add google https://github.com/google/styleguide

To incorporate google's changes:

git fetch google gh-pages

## Merge workflow (clean, no new commits)
git checkout master -b updates
git merge google/gh-pages # this will have a lot of conflicts
# ... solve conflicts
git merge -- continue

## Rebase workflow (dirty, creates new commits)
git checkout -b updates FETCH_HEAD
git rebase master # this will have a lot of conflicts, most of which can be solved with the next command (run repeatedly)
# solve conflicts with files deleted in our fork (this is idempotent and safe to be called. when cpplint.py has conflicts, it will do nothing)
git status | grep 'new file:' | awk '{print $3}' | xargs -r git rm --cached ; git status | grep 'deleted by us' | awk '{print $4}' | xargs -r git rm
git status --untracked-files=no | grep 'nothing to commit' && git rebase --skip

git push -u origin updates
# check travis
git push origin --delete updates

git rebase updates master
git branch -D updates
git push

Setup fetching of pull requests in .git/config:

[remote "origin"]
    url = [email protected]:cpplint/cpplint.git
    fetch = +refs/heads/*:refs/remotes/origin/*
# following line should be new, fetches PRs from cpplint
    fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
[remote "google"]
    url = https://github.com/google/styleguide
    fetch = +refs/heads/*:refs/remotes/google/*
# following line should be new, fetches PRs from google/styleguides
    fetch = +refs/pull/*/head:refs/remotes/google/pr/*

To compare this for with upstream (after git fetch):

git diff google/gh-pages:cpplint/cpplint.py master:cpplint.py
git diff google/gh-pages:cpplint/cpplint_unittest.py master:cpplint_unittest.py