Skip to content

Commit

Permalink
minor clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
quentinblampey committed Sep 21, 2023
1 parent 74a5f06 commit 5e28dad
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 85 deletions.
15 changes: 2 additions & 13 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# Misc
cytospace
show_small.py
archive/
workflow/.snakemake
workflow/logs
*ignore*
archive/
explore
sandbox

Expand All @@ -14,7 +12,7 @@ sandbox
# Documentation
site

# Code Ocean related
# Code Ocean
code
results

Expand All @@ -25,15 +23,6 @@ lightning_logs
checkpoints
run.log

# Data files
data/*/*
!data/aml/default.csv
!data/aml/short.h5ad
!data/bmmc/default.csv
!data/poised/default.csv
!data/debarcoding/default.csv
!data/README.md

# Jupyter Notebook
.ipynb_checkpoints
exploration/*
Expand Down
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Contributions are welcome as we aim to continue improving the pipeline. For inst
- Submitting a fix
- Proposing new features

## Contributing to the code, or debugging
## Pull Requests

Even though *sopa* is meant for flamingo, you can set up this repository locally for development or debugging purposes.
To add some new code to **sopa**, you should:

1. Install the dependencies.
2. Create your personal branch from `master`.
Expand All @@ -21,8 +21,7 @@ Even though *sopa* is meant for flamingo, you can set up this repository locally
## Coding guidelines

- Use the `black` formatter and `isort`. Their usage should be automatic as they are in the `pyproject.toml` file. Depending on your IDE, you can choose to format your code on save.
- Follow the [PEP8](https://peps.python.org/pep-0008/) style guide. In particular, use snake_case notations (and PascalCase for classes).
- Follow the [PEP8](https://peps.python.org/pep-0008/) style guide.
- Provide meaningful names to all your variables and functions.
- Document your functions and type your function inputs/outputs.
- Create your functions in the intended file, or create one if needed. See the project layout.
- Try as much as possible to follow the same coding style as the rest of the repository.
68 changes: 0 additions & 68 deletions workflow/_Snakefile

This file was deleted.

0 comments on commit 5e28dad

Please sign in to comment.