Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (47 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

75 lines (47 loc) · 2.25 KB

Contributing to Docerium

First off, thank you for considering contributing to Docerium! It's people like you that make Docerium such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Getting Started

Prerequisites

Fork & Clone

  1. Fork the repository to your own GitHub account.
  2. Clone your fork to your local machine: 
    git clone https://github.com/YOUR_USERNAME/docerium.git
cd docerium/public

Setup

  1. Install dependencies:

    npm install

  2. Run the development server:

    npm run dev

Open http://localhost:3000 with your browser to see the result.

Making Changes

  1. Create a new branch for your changes:

    git checkout -b your-feature-name

    Please use a descriptive branch name (e.g., feat/add-new-button or fix/fix-dock-bug).

  2. Make your changes to the codebase.

    • The main application code is in the public/src directory.
    • Ensure your code follows the existing style. We use ESLint for linting. You can check your code by running npm run lint.

  3. Commit your changes with a descriptive commit message. We follow the Conventional Commits specification.

    git commit -m "feat: Add a new amazing feature"

Submitting a Pull Request

  1. Push your branch to your fork:

    git push origin your-feature-name

  2. Open a Pull Request from your fork to the master branch of the original repository.

  3. Fill out the Pull Request template with the required information.

  4. Wait for a review. We'll review your pull request as soon as possible. We may suggest some changes or improvements.

Code of Conduct

We have a Code of Conduct that we expect all contributors to adhere to. Please read it before contributing.

Thank you again for your contribution!