blob: 053c5aae3a907db89cd7c07f7fa68e5464c2b185 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
# Contributing
Here are some ways you can contribute:
- Implement [new probes](https://genderbench.readthedocs.io/latest/developing_probes.html) or metrics.
- Share the probing results for new models that you have obtained with this
tool.
- Share anything interesting you have done with this tool.
- Submit code changes to fix issues or implement new features.
- Report bugs or suggest features.
- Fix typos, improve documentation, or update examples.
- Contribute with credits for various LLM APIs.
## Reporting Issues
Any bugs, issues, ideas for new features, probes, metrics, etc., are welcomed.
Please create a new GitHub issue.
## Getting Started
Before developing new features, please start a discussion in the _Issues_
section.
1. Fork and clone the repository.
2. Install Poetry `pip install poetry`.
3. Install the library itself `poetry install`.
4. Develop your code.
5. Format the code with `poetry run make format`.
6. Test the code with `poetry run make test`. Develop your own tests if necessary.
7. Build the documentation if necessary with `cd docs; poetry run make clean html`.
8. Push the code into the repository and create a pull request.
We appreciate your contributions and look forward to your involvement in
the project! 🎉
## Licensing
By contributing to this project, you agree that your contributions will be
licensed under the MIT License.
|
