Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (33 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.58 KB

Contributing to AsciiDoc Alive

Thank you for your interest in contributing to AsciiDoc Alive! This document provides a set of guidelines for contributing to the project.

Development Setup

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/asciidocalive.git
  3. Install dependencies: npm install
  4. Start the development server: npm run dev

Development Workflow

  1. Create a new branch for your feature or bugfix: git checkout -b feature/your-feature-name
  2. Make your changes
  3. Test your changes thoroughly
  4. Commit with a clear, descriptive message
  5. Push to your fork: git push origin feature/your-feature-name
  6. Open a pull request against the main repository

Code Style

  • Follow the existing code style in the project
  • Use TypeScript for all new code
  • Format your code using the project's ESLint configuration
  • Write comments for complex logic

Testing

Before submitting a pull request, make sure:

  • The application builds successfully with npm run build
  • Your changes work as expected
  • No new console errors appear

Pull Request Process

  1. Ensure your PR addresses a specific issue or adds clear value
  2. Provide a clear description of the changes
  3. Include screenshots for UI changes if applicable
  4. Be responsive to feedback and questions

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Questions?

If you have any questions, feel free to open an issue or reach out to the maintainers.