Skip to content

Latest commit

 

History

History
79 lines (47 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

79 lines (47 loc) · 3.35 KB
Raw

Contributing to Tarrasque App 🎉

Introduction

First off, thanks for taking the time to contribute! ❤️ Your support is crucial for the project's development and success. This document outlines how you can contribute to Tarrasque App. Whether it's through bug fixes, feature additions, documentation improvements, or more, your contributions are greatly appreciated.

Getting Started

Before diving in, please ensure you have a GitHub account and have familiarized yourself with the Tarrasque App project by reading the README.md and other documentation. This will help you get a good idea of the project's current state and future direction.

For Non-Technical Contributors

Not a coder? No problem! Your input is incredibly valuable whether you're reporting bugs or suggesting new features. Here's how you can contribute:

🐞 Reporting Bugs

  1. Check Existing Issues: Before submitting a new bug report, take a moment to check the project's issue tracker to avoid duplicates.
  2. Create an Issue: Found something new? Use the GitHub issue tracker to submit a detailed report. Please include steps to reproduce the bug, what you expected to happen, and what actually happened. Screenshots or videos are super helpful!

✨ Requesting Features or Enhancements

  1. Check Existing Requests: Take a look through the issue tracker to see if someone else has already requested your feature.
  2. Submit a New Feature Request: If your idea is fresh, open an issue to share your vision for the feature. Explain why it would be a fantastic addition to the project and how it might work.

For Developers

Ready to dive into the code? Here's how you can contribute your coding skills:

Setup

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
git clone https://github.com/your_username/tarrasqueapp.git
  1. Set up the development environment as described in the project's README.md.

Making Changes

  1. Create a new branch for your awesome changes.
git checkout -b my-amazing-feature
  1. Make your changes. Be sure to stick to the project's coding standards and guidelines.
  2. Commit your changes with clear, descriptive commit messages.
git commit -am 'Add some amazing feature'
  1. Push your changes to your fork on GitHub.
git push origin my-amazing-feature

Submitting a Pull Request

  1. Head over to the repository on GitHub and click the "New pull request" button.
  2. Choose your branch and give a detailed description of your changes, including the purpose of the pull request and any issues it addresses.
  3. Submit the pull request and bask in the glory of your contribution!

Review Process

After submission, your pull request will be reviewed by the project maintainers. This ensures that we maintain high-quality standards. We may ask for further changes; please be patient and keep the lines of communication open.

Code of Conduct

We're committed to building a welcoming and inclusive community. All contributors are expected to adhere to the project's Code of Conduct. Let's keep our communication respectful and constructive.

Questions?

Got questions or need more guidance? Feel free to open an issue on GitHub or contact the project maintainers directly. We're here to help and are excited about your interest in contributing to Tarrasque App.

Thanks! ❤️