File: CONTRIBUTING.md

package info (click to toggle)
translate-toolkit 3.18.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,948 kB
  • sloc: python: 70,547; sh: 1,412; makefile: 186; xml: 48
file content (49 lines) | stat: -rw-r--r-- 1,564 bytes parent folder | download
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
40
41
42
43
44
45
46
47
48
49
# Contributing to Translate Toolkit

Thank you for your interest in contributing to the Translate Toolkit!

## Quick Start for Developers

### Prerequisites
- Git
- Python 3.10 or newer
- [uv](https://docs.astral.sh/uv/) (recommended package manager)

### Setup

1. Clone the repository:
   ```bash
   git clone https://github.com/translate/translate.git
   cd translate
   ```

2. Install all dependencies (creates a virtual environment in `.venv`):
   ```bash
   uv sync --all-extras --dev
   ```

3. Run the tests:
   ```bash
   make test
   ```

## How to Contribute

For detailed information about contributing, please see our [full contributing guide](https://docs.translatehouse.org/projects/translate-toolkit/en/latest/developers/contributing.html).

### Ways to Contribute
- **Testing** - Help test new candidate releases
- **Debugging** - Check bug reports and create tests
- **Developing** - Add features or fix bugs
- **Documenting** - Improve documentation

## Communication

- [Issue tracker](https://github.com/translate/translate/issues) - for bug reports, discussions, and questions
- [Discussions](https://github.com/translate/translate/discussions) - for general discussions and help

## Documentation

- [Developer Guide](https://docs.translatehouse.org/projects/translate-toolkit/en/latest/developers/developers.html)
- [Testing Guide](https://docs.translatehouse.org/projects/translate-toolkit/en/latest/developers/testing.html)
- [Style Guide](https://docs.translatehouse.org/projects/translate-toolkit/en/latest/developers/styleguide.html)