Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

88 lines (64 loc) · 2.61 KB
Raw

Contributing to Adkar Champ

Thank you for considering contributing to Adkar Champ! We appreciate your interest and welcome any help you can offer. Here are some guidelines to get you started.

Table of Contents

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub and include as much detail as possible. Use the provided bug report template and include the following:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected and actual results
  • Screenshots, if applicable
  • Any relevant error messages or logs

Suggesting Features

We are always open to new ideas! If you have a feature suggestion, please open an issue on GitHub and include:

  • A clear and descriptive title
  • A detailed description of the feature
  • Any relevant use cases or user stories
  • Any mockups or examples that could help illustrate the feature

Code Contributions

We welcome code contributions! Here’s how you can get started:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Make your changes.
  4. Test your changes thoroughly.
  5. Commit your changes (git commit -m 'Add some feature').
  6. Push to the branch (git push origin feature/your-feature).
  7. Open a pull request.

Getting Started

Prerequisites

Make sure you have Node.js and npm installed. You can install them from nodejs.org.

Installation

  1. Fork and clone the repository. 
    git clone https://github.com/zameel7/adkar-streak.git
cd adkar-streak
  2. Install the dependencies. 
    npm install
  3. Start the development server. 
    npx expo start

Pull Request Guidelines

  • Follow the code style of the project.
  • Write clear and concise commit messages.
  • Test your changes before submitting a pull request.
  • Reference the issue number in your pull request, if applicable.
  • Include screenshots or videos of your changes in action, if applicable.

Style Guide

  • Follow the TypeScript and React/React Native style guides.
  • Use meaningful variable and function names.
  • Keep functions and components small and focused.
  • Write comments to explain complex code.
  • Format your code using Prettier (configuration is provided).

Thank you for contributing to Adkar Champ! Your help is greatly appreciated.