Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (76 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

116 lines (76 loc) · 2.09 KB
Raw

Contributing

Thank you for your interest in contributing to seo-engine!

Whether you're fixing a bug, improving documentation, or proposing a new feature, your contributions are welcome.

Development Setup

  1. Fork the repository.
  2. Clone your fork.
  3. Install dependencies:
npm install
  1. Start making changes in a new branch.

Development Scripts

Run tests:

npm test

Run tests with coverage:

npm run test:coverage

Run all checks:

npm run check

Build the package:

npm run build

Branch Naming

Use descriptive branch names such as:

  • feat/...
  • fix/...
  • docs/...
  • chore/...
  • refactor/...
  • test/...

Commit Messages

Please use clear and consistent commit messages following the Conventional Commits style.

Examples:

  • feat: add Open Graph plugin
  • fix: handle missing canonical URL
  • docs: improve README
  • chore: update dependencies

Code Style

Before opening a pull request, ensure the project passes all checks:

npm run check

Code is formatted with Prettier and linted with ESLint.

Making Changes

When adding or modifying features:

  • Keep changes focused and well documented.
  • Prefer extending the existing API instead of introducing unnecessary breaking changes.
  • Update documentation when changing public behavior.
  • Add or update tests when applicable.

For user-facing changes, add a changeset:

npm run changeset

Changesets are used to track package changes and prepare releases.

Pull Requests

Before submitting a pull request:

  • Keep changes focused on a single topic.
  • Ensure all checks pass.
  • Update documentation when necessary.
  • Add or update tests when applicable.
  • Include a clear description of the change and its motivation.

Bug Reports

When reporting a bug, include:

  • A clear description of the problem.
  • Steps to reproduce it.
  • Expected behavior.
  • Actual behavior.
  • Environment details such as Node.js version.

Questions

If you have questions or ideas for improvements, feel free to open an issue.