Adding a New Language
Step-by-step guide for adding a new language ecosystem to DevRail.
Contributing
How to contribute to the DevRail ecosystem – adding languages, submitting pull requests, and understanding the repo structure.
DevRail is an open ecosystem. Contributions are welcome, whether you want to add support for a new language, improve documentation, or fix bugs.
Getting Started
Before contributing, familiarize yourself with:
- The DevRail standards – understand the tooling conventions your contribution must follow
- The ecosystem structure – understand which repo to contribute to
- The pull request process – understand the workflow and CI expectations
Contribution Types
| Type | Where to Contribute | Guide |
|---|---|---|
| Add a new language | dev-toolchain + devrail-standards | Adding a Language |
| Author a plugin | A new devrail-plugin-<name> repo | Contributing a Plugin |
| Fix a bug | The repo where the bug exists | Pull Requests |
| Improve documentation | devrail.dev (this site) | Pull Requests |
| Update a tool version | dev-toolchain | Pull Requests |
| Add a CI feature | github-repo-template or gitlab-repo-template | Pull Requests |
Development Setup
To contribute to the devrail.dev documentation site:
# Clone the documentation site repository
git clone https://github.com/devrail-dev/devrail.dev.git
cd devrail.dev
# Install pre-commit hooks
make install-hooks
# Start the local development server
make serve
The site is available at http://localhost:1313/. Changes to content files are automatically reloaded.
Prerequisites
| Tool | Purpose | Install Guide |
|---|---|---|
| Hugo extended | Build the documentation site | Hugo Installation |
| Go >= 1.21 | Required for Hugo modules | Go Installation |
| Docker | Run make check | Docker Installation |
| pre-commit | Git hook management | pip install pre-commit |
To contribute to other DevRail repos, the prerequisites are simpler – only Docker and Make are required, since all tools run inside the dev-toolchain container.
Contribution Guides
- Adding a New Language – Step-by-step guide for adding language ecosystem support
- Contributing a Plugin – Author a plugin that ships a new language or tool integration without forking the core
- Submitting Pull Requests – Workflow, conventional commits, CI expectations
- Ecosystem Structure – Repo map and relationships
Contributing a Plugin
Step-by-step guide for authoring a DevRail plugin that ships a new language ecosystem or tool integration without forking the core repos.
Submitting Pull Requests
Pull request workflow, conventional commits, CI expectations, and code review process.
Ecosystem Structure
Map of all DevRail repositories, their purposes, and how they relate to each other.