Skip to content

Commit 4d09cfe

Browse files
committed
Update contributing guidelines
1 parent cf0ed46 commit 4d09cfe

File tree

2 files changed

+30
-28
lines changed

2 files changed

+30
-28
lines changed

docs/CONTRIBUTING.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,62 @@
11
# Contributing to TransformerRanker
22

3-
__Thanks__ for your interest in contributing to `transformer-ranker`! We're building a lightweight tool for ranking language models via transferability.
4-
Finding bugs, proposing enhancements, or opening pull requests, your involvement shapes the project.
3+
__Thanks__ for your interest in contributing to `transformer-ranker`! We're building a lightweight tool for ranking language models via transferability.
54

6-
## Before Coding
5+
Spotted a bug, got an idea, or want to open a PR? any kind of involvement helps shape where it goes.
76

8-
Please check existing [issues](https://github.com/flairNLP/transformer-ranker/issues) and [pull requests](https://github.com/flairNLP/transformer-ranker/pulls) to avoid duplicate work.
7+
## See Exiting Work
98

10-
If you're working on something new, consider opening an issue first to discuss it.
9+
Before starting, check open [issues](https://github.com/flairNLP/transformer-ranker/issues) and [pull requests](https://github.com/flairNLP/transformer-ranker/pulls) to avoid duplicates.
10+
Planning something new? Consider opening an issue first. Discussion is welcome.
1111

1212
## Setup
1313

14-
TransformerRanker requires Python 3.9 or higher.
15-
We recommend using Python 3.9.x during development.
16-
17-
Install dev dependencies with:
14+
We recommend Python 3.9.x during development. To install dev dependencies:
1815

1916
```bash
2017
pip install -e ".[dev]"
2118
```
2219

23-
Make sure you’re using a clean environment (conda or virtualenv).
24-
Check out the examples and tests to understand the interface better.
20+
Use a clean environment (virtualenv or conda).
21+
Explore `examples/` and `tests/` to get familiar.
22+
23+
## Code Style & Linting
2524

26-
## Formatting
25+
We use:
2726

28-
We use [`black`](https://github.com/psf/black) for formatting [`ruff`](https://github.com/charliermarsh/ruff) for linting and imports.
27+
- [black](https://github.com/psf/black) — code formatting
28+
- [ruff](https://github.com/astral-sh/ruff) — linting & import sorting
2929

30-
To auto-format your code:
30+
To format:
3131

3232
```bash
3333
black . && ruff --fix .
3434
```
3535

36-
## Testing
36+
## Run Tests
3737

38-
We use pytest for running unit tests. Run all tests using:
38+
Tests are written using pytest. Run all tests with:
3939

4040
```bash
4141
pytest tests
4242
```
4343

44-
## Adding Transferability Metrics
44+
## Add New Transferability Metrics
4545

46-
New metrics should be added to `transformer-ranker/estimators/`. When contributing, include docstrings with links to relevant papers to help others understand the approach. Use comments to make your code easy to follow.
4746

48-
## Enhancements
47+
New metrics go in `transformer_ranker/estimators/`.
48+
Include docstrings and paper references. Clear comments = appreciated.
4949

50-
Test the tool with unusual models and datasets. Open issues or PRs if you encounter unsupported models. Consider exploring ways to apply transferability to other tasks, such as summarization.
50+
## Explore and Expand
5151

52-
## Get Involved
52+
Try weird models or datasets. If something fails — open an issue.
53+
Ideas for model ranking for tasks like summarization are also welcome.
5354

54-
Ways to contribute:
55+
## Enhancements
56+
57+
Test the tool with unusual models and datasets. Open issues or PRs if you encounter unsupported models. Consider exploring ways to apply transferability to other tasks, such as summarization.
5558

56-
- Open issues to report bugs, suggest improvements, or ask questions.
57-
- Add new transferability metrics.
58-
- Test the tool with unusual models and datasets.
59+
----------------
5960

60-
Hope this helps, we actively welcome your contributions!
61+
Contributions big or small are appreciated! 🚀
62+
Want to suggest something now? → Open an [issues](https://github.com/flairNLP/transformer-ranker/issues)

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Documentation
22

3-
__Welcome__ to the docs (/tutorials) for TransformerRanker. This tool lets you rank language models on downstream NLP tasks.
4-
Right now it supports token, text, text-pair classification and regression tasks.
3+
__Welcome__ to the docs (/tutorials) for TransformerRanker. It is a lightweight tool for ranking language models on downstream NLP tasks.
4+
It currently supports token, text, text-pair classification and regression tasks.
55

66
# Content
77

0 commit comments

Comments
 (0)