Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.16 KB

contributing.md

File metadata and controls

57 lines (38 loc) · 2.16 KB
Raw

CONTRIBUTING to Vets Who Code Web App

Hello and thank you for your interest in contributing to the Vets Who Code web app. We appreciate your effort and support. This document provides guidelines for contributing.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Reporting Bugs
  4. Feature Requests
  5. Pull Request Process
  6. Code Style and Linting
  7. Testing
  8. Further Help

Code of Conduct

Our community has a Code of Conduct, and we ask that you read and follow it. This helps ensure a welcoming and inclusive environment for everyone.

Getting Started

  • Make sure you have a GitHub account.
  • Fork the repository on GitHub.
  • Clone your fork to your local machine.

Reporting Bugs

  • Ensure the bug hasn't already been reported by searching the Issues.
  • If the bug hasn't been reported, open a new Issue. Be sure to provide a clear title, a detailed description, and steps to reproduce the issue.

Feature Requests

  • Check if the feature has already been requested.
  • If it hasn't, open a new Issue with a clear title and detailed description of the feature you'd like to see.

Pull Request Process

  1. Create a new branch for your feature or fix.
  2. Make your changes, ensuring you follow the code style guidelines.
  3. Commit your changes, using a clear and descriptive commit message.
  4. Push your branch to GitHub.
  5. Open a Pull Request against the main branch.
  6. Ensure your PR description clearly describes the problem and solution.

Code Style and Linting

  • We use Prettier and ESLint for code styling and linting. Make sure your code adheres to our configurations.
  • Run the linter before submitting a PR to ensure your code passes.

Testing

  • Add tests for any new features or fixes.
  • Ensure all tests pass before submitting a PR.

Further Help

If you have any questions or need further assistance, please reach out to (Jerome Hardaway)[https://github.com/jeromehardaway].