Skip to content

Remove CLA, update CONTRIBUTING guide with testing and linting instructions #97

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
merged 2 commits into from
Jan 13, 2024
Merged

Remove CLA, update CONTRIBUTING guide with testing and linting instructions #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5649d62
Remove CLA, since Upside Travel no longer exists. Update CONTRIBUTING…
dantheman39 Jan 13, 2024
b610989
Add section on pre-commit
dantheman39 Jan 13, 2024
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
26 changes: 12 additions & 14 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,20 @@ This will install the repo version of
`graphene-pydantic` and then install the development dependencies. Once that
has completed, you can start developing.

## Contributor License Agreement
### Running tests

To run the tests locally, you can simply run `pytest`.

We require all contributors to sign the [Upside CLA](./CONTRIBUTOR_LICENSE_AGREEMENT.md).
In CI, we run tests using [nox](https://nox.thea.codes/en/stable/index.html),
which runs the test multiple times using different package versions. Run
`poetry run nox` to run the entire test suite.

In simple terms, the CLA affirms that the work you're contributing is original,
that you grant Upside permission to use that work (including license to any
patents necessary), and that Upside may relicense your work for our commercial
products if necessary. Note that this description is a summary and the specific
legal terms should be read directly in the CLA.
### Pre-commit, linting

The CLA does not change the terms of the standard open source license used by
our software. You are still free to use our projects within your own projects or
businesses, republish modified source, and more. Please reference the license of
this project to learn more.
We use [pre-commit](https://pre-commit.com/) to manage git pre-commit hooks. This
will fail linting locally so you can see errors before they run in CI. Run `pre-commit install`
to install the hooks.

To sign the CLA, open a pull request as usual. If you haven't signed the CLA
yet, we cannot merge any pull request until the CLA is signed. You only need to
sign the CLA once.
To run them manually, run `pre-commit run --all-files`.

To skip them when committing, run `git commit` with the `--no-verify` flag.
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ This project depends on third-party code which is subject to the licenses set fo

### Contributing

Please see the [Contributing Guide](./CONTRIBUTING.md). Note that you must sign the [CLA](./CONTRIBUTOR_LICENSE_AGREEMENT.md).
Please see the [Contributing Guide](./CONTRIBUTING.md).

### Caveats

Expand Down