Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

84 lines (53 loc) · 3.23 KB
Raw
title
Contributing to pottercast

Contributing to Harry Potter App

Welcome to the contribution guide for [Your Project Name]! We appreciate your interest in making this project even better. Whether you're a developer, designer, tester, or a documentation enthusiast, there are plenty of ways to contribute.

Before you get started, please take a moment to read and understand the guidelines outlined in this document. This will ensure a smooth and collaborative contribution process.

Table of Contents

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it carefully before participating.

Ways to Contribute

Bug Reports and Feature Requests

If you encounter a bug while using [Your Project Name] or have a feature you'd like to suggest, please open an issue on our GitHub repository. Provide as much detail as possible to help us understand and replicate the problem.

Pull Requests

We welcome pull requests! If you'd like to contribute code to [Your Project Name], follow these steps:

Fork the Repository

Fork the repository on GitHub and clone your fork locally.

Setting Up the Development Environment

Follow the instructions in our Development Setup guide to set up your development environment.

Making Changes

Make your changes on a new branch created from the main branch. Please ensure your code follows our code style guidelines.

Testing

Write tests to cover your changes and ensure that existing tests pass.

Submitting a Pull Request

When you're ready to submit your changes, push your branch to your fork and create a pull request to the main branch of the main repository. Provide a clear description of your changes and the problem they solve.

Documentation

Improvements to documentation are always appreciated. If you see a typo, unclear instructions, or something that needs better explanation, feel free to submit a pull request.

Getting Started

To start contributing to [Your Project Name], follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository locally.
  3. Set up your development environment.
  4. Create a new branch for your changes.
  5. Make and commit your changes.
  6. Run tests to ensure everything is working.
  7. Push your changes to your fork on GitHub.
  8. Create a pull request.

Code Style

We follow coding convention for typescript and react

Contact

reach out at the provide contact at my github