Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

101 lines (76 loc) · 2.57 KB

Contributing to PixivCompose

Thank you for considering contributing to PixivCompose! Your time and effort are greatly appreciated. This guide outlines the steps to contribute effectively.

Table of Contents

  1. How Can You Contribute?
  2. Setting Up the Project
  3. Submitting a Pull Request
  4. Style Guide
  5. Reporting Issues

How Can You Contribute?

Here are some ways to contribute to the project:

  • Reporting bugs or issues.
  • Suggesting new features or enhancements.
  • Writing or improving documentation.
  • Submitting pull requests for fixes or new functionality.
  • Reviewing existing pull requests.

Setting Up the Project

  1. Fork the repository to your GitHub account.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/PixivCompose.git
  3. Navigate to the project directory: 
    cd PixivCompose
  4. Install the required dependencies: 
    ./gradlew build
  5. Run the tests to verify the setup: 
    ./gradlew test

Submitting a Pull Request

  1. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  2. Make your changes and commit them: 
    git add .
git commit -m "feat/fix(...): brief description of the feature/fix"
  3. Push the branch to your fork: 
    git push origin feature/your-feature-name
  4. Open a pull request:
    • Go to the original repository on GitHub.
    • Click the "New Pull Request" button.
    • Select your branch and submit the pull request.

Pull Request Guidelines

  • Reference any related issues (e.g., Fixes #123).
  • Ensure your branch is up to date with the main branch.
  • Add tests for new features or bug fixes, if applicable.
  • Follow the Style Guide.

Style Guide

Reporting Issues

If you encounter a bug or want to suggest a new feature:

  1. Check the Issues tab to see if it has already been reported.
  2. If not, open a new issue and include the following:
    • A clear and concise description.
    • Steps to reproduce (for bugs).
    • Expected vs. actual behavior.
    • Relevant screenshots or logs, if applicable.

Thank you for contributing to PixivCompose! 🚀