Skip to content

chore: update contribution #596

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
JoanFM merged 4 commits into from
Oct 7, 2022
Merged

chore: update contribution #596

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5d097ef
chore: update contribution
Oct 7, 2022
d62ca9f
feat: apply aleaddine suggestion
samsja Oct 7, 2022
f84329c
feat: apply johannes suggestion
samsja Oct 7, 2022
b83e13c
feat: apply nicholas suggestion
samsja Oct 7, 2022
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
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ In this guide, we're going to go through the steps for each kind of contribution

- [🐞 Bugs and Issues](#-bugs-and-issues)
- [🥇 Making Your First Submission](#-making-your-first-submission)
- [📝 Code style conventions](#-code-style-conventions)
- [☑️ Naming Conventions](#-naming-conventions)
- [💥 Testing DocArray Locally and on CI](#-testing-docarray-locally-and-on-ci)
- [📖 Contributing Documentation](#-contributing-documentation)
Expand Down Expand Up @@ -80,7 +81,7 @@ Now you will be automatically reminded to add docstrings to your code. `black` w

Run `git config blame.ignoreRevsFile .github/.git-blame-ignore-revs`

## Code style conventions:
## 📝 Code style conventions:

Most of our codebase is written in Python.

Expand Down Expand Up @@ -224,6 +225,14 @@ pip install ".[test]"
pytest -v -s tests
```

### Test policy

Every contribution that adds or modifies the behavior of a feature must include a suite of tests that validates that the feature works as expected.

This allows:
* the reviewer to be very confident that the feature does what it is supposed to do before merging it into the code base
* the contributors to be sure that they don't break already-merged features when refactoring or modifying the code base.

<a name="-contributing-documentation"></a>
## 📖 Contributing Documentation

Expand Down