Skip to content

Latest commit

 

History

History
57 lines (45 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

57 lines (45 loc) · 1.38 KB
Raw

Contributing to freeWriter

We welcome contributions to the freeWriter project! This document provides guidelines for contributing to the project.

Getting Started

  1. Fork the repository on GitLab.
  2. Clone your fork locally: 
    git clone https://gitlab.com/your-username/freewriter.git
cd freewriter
  3. Install dependencies: 
    npm run install-all
  4. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name

Development Workflow

  1. Make your changes in the appropriate files.
  2. Write or update tests for your changes.
  3. Ensure all tests pass: 
    npm test
  4. Commit your changes: 
    git commit -m "Add your commit message here"
  5. Push to your fork: 
    git push origin feature/your-feature-name
  6. Create a merge request from your fork to the main repository.

Code Style

  • Follow the existing code style in the project.
  • Use meaningful variable and function names.
  • Comment your code where necessary.

Reporting Bugs

  • Use the GitLab issue tracker to report bugs.
  • Describe the bug in detail, including steps to reproduce.
  • Include the version of freeWriter you're using.

Suggesting Enhancements

  • Use the GitLab issue tracker to suggest enhancements.
  • Clearly describe the enhancement and its potential benefits.

Thank you for contributing to freeWriter!