Skip to content
This repository has been archived by the owner on Aug 29, 2024. It is now read-only.

Commit

Permalink
Update contributing note to mention forking of repository. (#384)
Browse files Browse the repository at this point in the history
* Update contributing note to mention forking of repository.

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: Hetal Kapadia <83311196+printhellohetal@users.noreply.github.com>
  • Loading branch information
HuifangYeo and printhellohetal committed Nov 17, 2022
1 parent ae65a78 commit e2cae0b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
We welcome any contributions from the community. Please make sure your PR follows the rules below:
We welcome any contributions from the community.

## Getting started

To get started, please proceed to

1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the atoti repository:

<img src="assets/fork_atoti_repo.png">

2. Pull the `main` branch (`git checkout main` and `git pull`) from the forked repository.
3. Run `poetry install` to be sure to work with the expected dependencies.
4. Create a working branch `git switch -c <PSEUDO>/<SUBJECT>`.
5. Start JupyterLab: `poetry run jupyter lab`.
6. Create the folder and notebooks.
Add notebooks responsible for data pre-processing to the [list of untested notebooks](tests/execute_notebooks.py).
The main notebook using atoti should be tested to ensure users can run it.
7. If a dependency is missing run `poetry add <DEPENDENCY_NAME>`: **DEPENDENCIES MUST NOT BEEN ADDED WITH CONDA OR PIP** since the Github CI relies on the `poetry.lock` file to install dependencies.
8. Commit and push changes to the forked repository using `git push`.
9. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) from the forked repository.

Please monitor the pull request as each pull request is subject to automatic code testing. The atoti team will review and comment on any pull requests to ensure each submission is aligned with the API's usage.


## Pull Request Rules
Please make sure your PR follows the rules below:

### General notebook rules

Expand All @@ -13,6 +38,7 @@ We welcome any contributions from the community. Please make sure your PR follow
- entrypoint should be named `main.ipynb`
- README TOC should be updated to link to the new notebook
- notebook should have an H1 title, matching folder name and README TOC
- create a README at notebook level to briefly introduce yourself and the use case.

### Data rules

Expand Down Expand Up @@ -51,17 +77,7 @@ These commands can be used while developing:
poetry run python tests/execute_notebooks.py
```

### How to write a notebook

1. Pull the `master` branch (`git checkout master` and `git pull`).
2. Run `poetry install` to be sure to work with the expected dependencies.
3. Create the working branch `git switch -c <PSEUDO>/<SUBJECT>`.
4. Start JupyterLab `poetry run jupyter lab`.
5. Create the folder and notebooks.
Add notebooks responsible for data pre-processing to the list of untested notebooks.
The main notebook using atoti should be tested to ensure users can run them.
6. If a dependency is missing run `poetry add <DEPENDENCY_NAME>`: **DEPENDENCIES MUST NOT BEEN ADDED WITH CONDA OR PIP** since the Github CI is relying on the `poetry.lock` file to install dependencies.
7. Push changes using `git push` and create the related pull request.


### About

Expand Down
Binary file added assets/fork_atoti_repo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e2cae0b

Please sign in to comment.