Skip to content

Latest commit

 

History

History
80 lines (59 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

80 lines (59 loc) · 3.47 KB
Raw

Contributing to TOTK Mod Manager

Welcome to the [TOTK Mod Manager] project! We appreciate your interest in contributing to our project. By contributing, you can help us improve and enhance the functionality, stability, and overall user experience.

Table of Contents

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Install the necessary dependencies using pnpm package manager and Tauri CLI.
  4. Familiarize yourself with the project structure and codebase.
  5. Choose an open issue from the issue tracker or work on a feature you'd like to contribute.
  6. Make the necessary changes or additions.
  7. Test your changes locally to ensure they work as intended.
  8. Commit your changes and push them to your forked repository.
  9. Submit a pull request to the main repository.

Contributing Guidelines

Reporting Issues

If you encounter any issues while using or testing the project, please report them using the following guidelines:

  1. Search the issue tracker to check if the issue has already been reported.
  2. If the issue hasn't been reported yet, create a new issue.
  3. Clearly describe the issue, including steps to reproduce if applicable.
  4. Provide any relevant error messages or screenshots.
  5. Assign appropriate labels and priorities to the issue.
  6. Be responsive to any follow-up questions or requests for clarification.

Feature Requests

If you have an idea for a new feature or enhancement, please follow these steps:

  1. Check the issue tracker to see if the feature has already been requested.
  2. If the feature hasn't been requested yet, create a new issue.
  3. Clearly describe the feature or enhancement you would like to see.
  4. Provide any additional context or examples to support your request.
  5. Assign appropriate labels and priorities to the issue.
  6. Engage in any discussions or brainstorming related to the feature.

Pull Requests

We welcome pull requests for bug fixes, improvements, and new features. To submit a pull request, please follow these guidelines:

  1. Create a new branch from the latest main branch.
  2. Make your changes in the new branch.
  3. Write clear and concise commit messages.
  4. Include tests and ensure all existing tests pass.
  5. Update the project documentation if necessary.
  6. Submit the pull request, clearly describing the changes and their purpose.
  7. Be responsive to any feedback or review comments.

Development Setup

To set up your local development environment, please follow these steps:

  1. Clone the repository to your local machine.
  2. Install the project dependencies using pnpm install.
  3. Set up any required environment variables.
  4. Run the development server using pnpm tauri dev.
  5. Open the project in your preferred code editor.
  6. Make your changes and test them locally.
  7. Commit your changes and push them to your forked repository.

Code of Conduct

We expect all contributors to follow our Code of Conduct. Please be respectful and considerate when interacting with other community members.