Skip to content

Commit

Permalink
removed development workflow section
Browse files Browse the repository at this point in the history
  • Loading branch information
PhidLarkson authored Nov 24, 2024
1 parent 01164b2 commit c5eb9bd
Showing 1 changed file with 1 addition and 32 deletions.
33 changes: 1 addition & 32 deletions contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Below, you'll find a guide to help you contribute smoothly.

## Table of Contents
- [Setting Up Your Development Environment](#setting-up-your-development-environment)
- [Development Workflow](#development-workflow)
- [Coding Standards and Best Practices](#coding-standards-and-best-practices)
- [Testing Your Code](#testing-your-code)
- [Submitting a Pull Request](#submitting-a-pull-request)
Expand Down Expand Up @@ -36,37 +35,7 @@ Make sure to create a virtual environment, then proceed.
```

We like clean contributions

## Development Workflow

1. **Create a Branch:**
Create a branch for your work. Use a meaningful name that hints at the purpose (e.g., `feature-enhance-translation`):
```bash
git checkout -b <branch-name>
```

2. **Implement Your Changes:**
- Modify or add code with attention to detail and consistency.
- Include proper documentation and comments where needed.
- Add or update unit tests to cover your changes.

3. **Run Tests Locally:**
Test thoroughly. Ensure your code doesn’t break existing functionality:
```bash
pytest
```

4. **Commit Your Work:**
Keep your commit messages descriptive and concise:
```bash
git add .
git commit -m "Added new preprocessing method for improved efficiency"
```

5. **Push to Your Branch:**
```bash
git push origin <branch-name>
```


## Coding Standards and Best Practices

Expand Down

0 comments on commit c5eb9bd

Please sign in to comment.