Skip to content

Latest commit

 

History

History
97 lines (65 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

97 lines (65 loc) · 2.2 KB

Contributing Guidelines

Thank you for considering contributing to our project! This document outlines the process and guidelines for contributing.

In this repo, you can contribute these following:

  • DevIniter Official Website
  • Documents

If you want to contribute to DevIniter CLI's behaviors, please check this repo

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing.

How to Contribute

  1. Fork the Repository

    • Create your own fork of the project
    • Clone it to your local machine

  2. Create a Branch

    git checkout -b feature/your-feature-name

  3. Make Your Changes

    • Write clean, documented code
    • Follow the existing code style and conventions
    • Add tests if applicable

  4. Commit Your Changes

    • Use clear and meaningful commit messages
    • Follow conventional commits format: 
      feat: add new feature
fix: resolve specific issue
docs: update documentation

  5. Push to Your Fork

    git push origin feature/your-feature-name

  6. Submit a Pull Request

    • Fill in the pull request template
    • Link any relevant issues
    • Provide a clear description of your changes

Development Setup

  1. Install dependencies:

    npm install  # or yarn install or pnpm install

  2. Run tests:

    npm test  # or yarn test or pnpm test

Pull Request Guidelines

  • PRs should target the master branch
  • Include tests for new features
  • Update documentation as needed
  • Ensure all tests pass
  • Follow the code style guidelines

Reporting Issues

  • Use the issue tracker
  • Include detailed steps to reproduce
  • Specify your environment details
  • Use the issue template if available

Code Style

  • Follow the established project coding style
  • Use consistent indentation
  • Add comments for complex logic
  • Keep functions focused and concise

Questions?

Feel free to reach out to the maintainers if you have any questions.

License

By contributing, you agree that your contributions will be licensed under the project's license.