Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
97 lines (65 loc) · 2.41 KB

CONTRIBUTING.md

File metadata and controls

97 lines (65 loc) · 2.41 KB

Contributing to Archivist Sync

Thank you for your interest in contributing to Archivist Sync!

Development Setup

Prerequisites

  • Node.js 18.x or 20.x
  • npm (comes with Node.js)

Getting Started

  1. Clone the repository
  2. Install dependencies: 
    npm install

Code Quality

This project uses ESLint and Prettier to maintain code quality and consistency.

Linting

Run the linter to check for issues:

npm run lint

Automatically fix formatting issues:

npm run lint:fix

Code Style

  • Use ES modules (import/export)
  • 2 spaces for indentation
  • Single quotes for strings
  • Semicolons required
  • Max line length: 100 characters

Pre-commit Checklist

Before committing your changes:

  1. ✅ Run npm run lint:fix to auto-format code
  2. ✅ Fix any remaining linting errors/warnings
  3. ✅ Test your changes in Foundry VTT

Continuous Integration

GitHub Actions automatically runs linting checks on all pull requests and pushes to main and tooling branches. Your code must pass these checks before being merged.

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run linting and fix any issues
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to your branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Release Workflow

This project uses automated releases for both production and beta versions:

  • Production releases (main branch): Automatically published to Foundry VTT when version is bumped
  • Beta releases (staging branch): Creates GitHub pre-releases for testing, manual install only

See .github/RELEASE_WORKFLOW.md for detailed documentation on:

  • How to create releases
  • Branch strategy
  • Version numbering
  • Beta testing process

Quick Reference

For Beta Testing:

  1. Merge your feature to staging
  2. Push to staging → automatic beta release created with auto-incrementing build number
  3. No version bump needed! (Only update version when targeting a new release)

For Production Release:

  1. Update CHANGELOG.md with release notes
  2. Merge staging to main
  3. Update versions in module.json and package.json if needed
  4. Push to main → automatic release + Foundry VTT publication

Questions?

If you have questions, please open an issue on GitHub.