Skip to content

docs: add CONTRIBUTING.md guide for new contributors#484

Open
JDis03 wants to merge 1 commit into
NeuralNomadsAI:devfrom
JDis03:docs/contributing-guide
Open

docs: add CONTRIBUTING.md guide for new contributors#484
JDis03 wants to merge 1 commit into
NeuralNomadsAI:devfrom
JDis03:docs/contributing-guide

Conversation

@JDis03
Copy link
Copy Markdown

@JDis03 JDis03 commented May 18, 2026

Summary

Adds a CONTRIBUTING.md file to help new contributors get started.

Contents

  • Quick start setup
  • Finding issues to work on (label guide)
  • Branch naming conventions
  • Development workflow (fork, branch, commit, PR)
  • Project structure overview with key file paths
  • Styling conventions and file size guidelines
  • i18n workflow for adding translations
  • Code principles (KISS, DRY, single responsibility)

This gives new contributors everything they need in one place to start contributing effectively.

Provides a complete onboarding guide covering:
- Quick start setup
- Finding issues to work on (label guide)
- Branch naming conventions
- Development workflow (fork, branch, commit, PR)
- Project structure overview with key file paths
- Styling conventions and file size guidelines
- i18n workflow for adding translations
- Code principles (KISS, DRY, single responsibility)

This gives new contributors everything they need in one place
to start contributing effectively.
@github-actions
Copy link
Copy Markdown

PR builds are available as GitHub Actions artifacts:

https://github.com/NeuralNomadsAI/CodeNomad/actions/runs/26045596021

Artifacts expire in 7 days.
Artifacts:

  • pr-484-1f08dd920f63824c086a3116d96bd59a191d5b31-tauri-macos
  • pr-484-1f08dd920f63824c086a3116d96bd59a191d5b31-tauri-windows
  • pr-484-1f08dd920f63824c086a3116d96bd59a191d5b31-tauri-linux
  • pr-484-1f08dd920f63824c086a3116d96bd59a191d5b31-tauri-macos-arm64
  • pr-484-1f08dd920f63824c086a3116d96bd59a191d5b31-electron-macos
  • pr-484-1f08dd920f63824c086a3116d96bd59a191d5b31-electron-windows
  • pr-484-1f08dd920f63824c086a3116d96bd59a191d5b31-electron-linux

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant