Skip to content

Commit

Permalink
docs: Add link to updated documentation in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cauliyang committed Oct 13, 2024
1 parent fbf8deb commit 2a6886a
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 2 deletions.
70 changes: 70 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Contributing to DeepChopper

We welcome contributions to DeepChopper! This document provides guidelines for contributing to the project.

## Getting Started

1. Fork the repository on GitHub.
2. Clone your fork locally:

```bash
git clone https://github.com/ylab-hi/DeepChopper.git
cd DeepChopper
```

3. Set up your development environment:

```bash
conda env create -n environment.yaml
conda activate deepchopper
pip install pipx
pipx install --suffix @master git+https://github.com/python-poetry/poetry.git@master
poetry@master install
```

## Making Changes

1. Create a new branch for your feature or bugfix:

```bash
git checkout -b feature/your-feature-name
```

2. Make your changes and commit them with a clear commit message.

3. Push your changes to your fork on GitHub:

```bash
git push origin feature/your-feature-name
```

4. Open a pull request against the main repository.

## Coding Standards

- Follow PEP 8 guidelines for Python code.
- Write clear, concise comments and docstrings.
- Ensure your code is compatible with Python 3.10+.

## Testing

- Add unit tests for new functionality.
- Ensure all tests pass before submitting a pull request:

## Documentation

- Update the README.md if you're adding or changing features.
- Add or update docstrings for new or modified functions and classes.

## Submitting Pull Requests

1. Ensure your PR description clearly describes the problem and solution.
2. Include the relevant issue number if applicable.
3. Make sure all tests pass and the code lints without errors.

## Reporting Issues

- Use the GitHub issue tracker to report bugs or suggest features.
- Provide as much detail as possible, including steps to reproduce for bugs.

Thank you for contributing to DeepChopper!
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,7 @@ poetry@master install

Need help? Have questions?

- 📖 Check our [Documentation](./docs)
- 💬 Join our [Community Forum](https://github.com/ylab-hi/DeepChopper/discussions)
- 📖 Check our [Documentation](./documentation/tutorial.md)
- 🐛 [Report issues](https://github.com/ylab-hi/DeepChopper/issues)

---
Expand Down
3 changes: 3 additions & 0 deletions documentation/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ This command takes the original FASTQ file (`raw.fastq`) and the predictions (`p
- **Issue**: Unexpected results
**Solution**: Verify input data quality and check DeepChopper version

- **Issue**: GPU driver compatibility error
**Solution**: Update your GPU driver or install a compatible PyTorch version e.g., `pip install torch --force-reinstall --index-url https://download.pytorch.org/whl/cu118` to install a CUDA 11.8 compatible version.

For more help, visit our [GitHub Issues](https://github.com/ylab-hi/DeepChopper/issues) page.

Happy sequencing, and may your data be artifical-chimera-free! 🧬🔍

0 comments on commit 2a6886a

Please sign in to comment.