Skip to content

Update documentation about PRs (& upd changelog) #274

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.

Sign up for GitHub

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

Merged
aaronliu0130 merged 1 commit into from
May 23, 2024
Merged

Update documentation about PRs (& upd changelog) #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ Alternatively, you can locally install patches like this::
pip install -e .[dev]
# for usage without virtualenv, add --user

Pull requests
-------------

When you're finished with a pull request, please:

* add a relevant test case to cpplint_unittest.py
* add a summary of what your changes do to CHANGELOG.rst
* specify the problem solved in the pull request
* make sure that your code passes the tests and lints
* don't force-push to the branch. These make the commit history messy, and we squash all commits when merging anyways.

.. _testing:

Testing
Expand All @@ -49,7 +60,7 @@ You can test your changes under your local python environment by running the tes
# install test requirements
pip install .[test]
# run a single test
pytest --no-cov cpplint_unittest.py -k testExclude
pytest --no-cov cpplint_unittest.py -k testName
# run a single CLI integration test
pytest --no-cov cpplint_clitest.py -k testSillySample
# run all tests. you don't have to run the above tests separately
Expand All @@ -68,9 +79,9 @@ The release process first prepares the documentation, then publishes to testpypi
.. code-block:: bash

# prepare files for release
vi cpplint.py # increment the version
vi changelog.rst # log changes
git add cpplint.py changelog.rst
$EDITOR cpplint.py # increment the version
$EDITOR changelog.rst # log changes
git add cpplint.py CHANGELOG.rst
git commit -m "Releasing x.y.z"
# Build
pip install --upgrade build wheel twine
Expand Down
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Changes
* JUnit XML output format
* Overriding repository root auto-detection via --repository
* Support ``#pragma once`` as an alternative to header include guards
* ... and `quite a bit <https://github.com/cpplint/cpplint/blob/master/changelog.rst>`_ more
* ... and `quite a bit <https://github.com/cpplint/cpplint/blob/master/CHANGELOG.rst>`_ more

Acknowledgements
================
Expand Down
3 changes: 2 additions & 1 deletion changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ A bunch of long-overdue modernizations of the codebase!
* NOLINT and NOLINTNEXTLINE comments now support a comma-separated list of categories, courtesy of @n3world (https://github.com/cpplint/cpplint/pull/220)
* NOLINT and NOLINTNEXTLINE will now ignore categories known to be from clang-tidy thanks to @xatier (https://github.com/cpplint/cpplint/pull/231)
* Fix behavior with nested source repositories by @groegeorg (https://github.com/cpplint/cpplint/pull/78)
* build/include-what-you-use no longer supports transitive headers from the header for the current module for parity with the style guide by @aaronliu0130
* build/include-what-you-use no longer supports transitive headers from the header for the current module for parity with the style guide by @aaronliu0130
* build/include-what-you-use now supports a plethora of new functions, courtesy of @geoffviola (https://github.com/cpplint/cpplint/pull/94)
* build/include-what-you-use will no longer err on similarly-named classes from other namespaces thanks to @geoffviola (https://github.com/cpplint/cpplint/pull/273)
* Indented functions inside namespaces will now be correctly erred on, courtesy of @Yujinmon (https://github.com/cpplint/cpplint/pull/235)
* C++20 headers will no longer be flagged as C headers thanks to @miker2 (https://github.com/cpplint/cpplint/pull/216)
* Same goes for C++23 and C23 headers, thanks to @aaronliu0130 (https://github.com/cpplint/cpplint/pull/239)
Expand Down