Dexor Docs

Appearance

We appreciate your interest in contributing to dexor.dev! There are several ways you can get involved in the project:

Reporting Issues ​

If you encounter any issues or bugs while using dexor.dev, please report them by following these steps:

  1. Navigate to our Issue Tracker.
  2. Check if the issue has already been reported. If it has, you can add any additional information you have.
  3. If the issue has not been reported, create a new issue and provide as much detail as possible, including steps to reproduce the problem and any relevant logs or screenshots.

Submitting Pull Requests ​

We welcome pull requests! To submit a pull request, follow these steps:

  1. Fork the Repository:

  2. Clone Your Fork:

    bash
    git clone https://github.com/your-username/dexor.dev.git dexor
cd dexor

  3. Create a Branch:

    bash
    git checkout -b feature/your-feature-name

  4. Make Your Changes:

    • Ensure your code follows the project's coding standards.
    • Write clear commit messages.

  5. Push Your Changes:

    bash
    git push origin feature/your-feature-name

  6. Create a Pull Request:

    • Go to your forked repository on GitHub.
    • Click the "New Pull Request" button and select the branch you created.
    • Provide a clear description of the changes you made and the reason for the changes.

Coding Standards ​

To maintain consistency, please ensure your code adheres to the following standards:

  • Follow the PSR-12 Coding Standard.
  • Use PHP CS Fixer to automatically fix coding standards issues.
  • Document your code thoroughly with comments.
  • Write tests for new features and bug fixes using PHPUnit.
  • Ensure all tests pass before submitting a pull request.

Improving Documentation ​

You can also contribute by improving our documentation. If you find any errors or areas that need clarification, follow these steps:

  1. Fork and Clone the Repository (same steps as above).

  2. Install Dependencies:

    bash
    cd dexor
npm install

  3. Run the Documentation Locally:

    bash
    npm run docs:dev

    This will start a local server using Vite, allowing you to view and edit the documentation in real-time.

  4. Editing Markdown Files:

    • The documentation is written in Markdown files located in the docs directory.
    • Make your changes to the relevant .md files.

  5. Push Your Changes and Create a Pull Request (same steps as above).

Join the Community ​

Join our community to stay up-to-date and to discuss ideas and features:

Thank you for your interest in contributing to dexor.dev! Your support and contributions help us improve and grow the project.