Skip to content

Latest commit

 

History

History
109 lines (80 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

109 lines (80 loc) · 3.16 KB
Raw

Contributing to Directus Sync

First off, thanks for taking the time to contribute! 🚀
We appreciate your interest in improving Directus Sync, and we welcome contributions of all kinds.

Table of Contents

How Can I Contribute?

Reporting Bugs

If you find a bug in Directus Sync, please create an issue on the issue tracker. Ensure that your bug report contains the following details:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • The expected and actual behavior.
  • Any relevant logs or screenshots.

Feature Requests

We're open to new ideas! If you have a feature request, please open an issue on GitHub using the [Feature Request] tag. Provide a detailed explanation of the feature and its potential impact.

Code Contributions

We welcome pull requests (PRs) for bug fixes, features, and documentation improvements.
Before submitting a PR, please make sure it adheres to the guidelines mentioned below.

Development Workflow

Setting Up the Environment

  1. Clone the repository:

    git clone https://github.com/tractr/directus-sync.git
cd directus-sync

  2. Install dependencies:

    npm install

  3. Add a new feature or fix a bug: Create a new branch for your changes. Make your changes and commit them.

  4. Build project: Make sure that the project is building correctly.

    npm run build

  5. Run tests:
    Make sure to run tests before submitting a PR to ensure that your code doesn't break existing functionality.

    npm test

Submitting Changes

  • Fork the repository and create a new branch for your feature or fix.
  • Write clear and descriptive commit messages.
  • Make sure your code is properly tested.
  • Open a pull request on the main branch with a description of your changes.
  • Ensure your PR passes CI checks.

Coding Guidelines

  • TypeScript: Ensure your code is strongly typed.
  • Error Handling: Handle errors gracefully and avoid crashing the CLI.
  • Logging: Use consistent logging practices, providing useful output for debugging purposes.

Style Guide

  • Use Prettier to format your code. 
     npm run format
  • Use ESLint to lint your code. 
     npm run lint
  • Follow consistent naming conventions.
  • Write meaningful comments, especially for complex logic.

Code of Conduct

This project follows a Code of Conduct to create a welcoming environment for everyone. Please read it before contributing.

Thank you for contributing to Directus Sync! ✨