Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.76 KB

contributing.md

File metadata and controls

49 lines (32 loc) · 1.76 KB
Raw

Contributing to DSC_Chuka

We are excited to have you contribute to our React project! This document provides guidelines and instructions to help you get started.

Getting Started

Before you begin, make sure you have the following installed:

  • Node.js version 18 or above
  • npm or yarn

Fork the repository and clone it locally. Install the dependencies by running npm install or yarn.

Development Workflow

  1. Create a branch: For each new feature or fix, create a new branch from main. git checkout -b your-branch-name
  2. Make your changes: Write code and tests that adhere to the project's coding standards.
  3. Test your changes: Ensure that all tests pass and your changes do not break existing functionality. npm test
  4. Lint your code: Make sure your code is clean and follows the project's style guide. npm run lint

Committing Your Changes

  • Write clear and meaningful commit messages.
  • Include any relevant issue numbers in your commit messages.
  • Push your commits to your branch in your fork.

Creating a Pull Request

  • Navigate to the original repository you forked from.
  • Click the "New pull request" button and select your branch.
  • Clearly describe the purpose of your pull request in the title and description.
  • Link any relevant issues.

Code Review

Once you submit your pull request, maintainers will review your code. Be responsive to feedback and make necessary changes if requested.

Community Guidelines

  • Be respectful and constructive in your communication.
  • Follow our Code of Conduct

Thank you for contributing to DSC_Chuka! We look forward to your contribution.

This CONTRIBUTING guide is a living document and may change over time. Feel free to suggest improvements or changes by opening an issue or a pull request.