Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (34 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 1.51 KB

Contributing to lightfeed/extractor

Thank you for considering contributing to lightfeed/extractor! This document outlines the process for contributing to the project and releasing new versions.

Development Workflow

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests to ensure everything works:
    • npm run test:unit - Run unit tests
    • npm run test:integration - Run integration tests (requires API keys)
    • npm run test:html2md - Run HTML to Markdown tests
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

CI/CD Pipeline

This project uses GitHub Actions for continuous integration and deployment:

Testing Workflow

The testing workflow runs automatically:

  • On each push to the main branch
  • On each pull request to the main branch
  • Weekly on Monday at midnight UTC

The workflow includes:

  1. Unit tests - Run across multiple Node.js versions
  2. Integration tests - Run on Node.js 20.x using provided API secrets

Release Process (Maintainers)

This project uses semantic versioning. To create a new release, tag main and push:

git tag v0.5.0
git push origin v0.5.0

When the tag is pushed, GitHub Actions will automatically:

  1. Set the version in package.json from the tag
  2. Build the package and run tests
  3. Create a GitHub Release with notes generated from git history
  4. Publish the package to npm