Skip to content

CONTRIBUTING.md

Latest commit

聽

History

History
79 lines (53 loc) 路 2.45 KB

CONTRIBUTING.md

File metadata and controls

79 lines (53 loc) 路 2.45 KB
Raw

Contributing to CodeFount

Thank you for your interest in contributing to CodeFount! We welcome contributions of all kinds, including new features, bug fixes, documentation improvements, and more.

Please take a moment to review this guide to ensure that your contributions adhere to our guidelines and standards.

Getting Started

  1. Fork the Repository:
    Click the "Fork" button at the top of this repository to create a copy of the repository in your own GitHub account.

  2. Clone the Repository:
    Clone the repository to your local machine:

    git clone https://github.com/your-username/CodeFount.git
cd CodeFount

  3. Install Dependencies: Run the following command to install the required dependencies:

npm install
  1. Create a Feature Branch: Use Git to create a new branch for your changes:
git checkout -b your-feature-branch
  1. Make Changes: Add your feature, fix bugs, or improve documentation.

Code Guidelines

To maintain code quality and consistency, please follow these guidelines:

Code Style: Use Prettier and ESLint to ensure code is consistently formatted and linted.

Commit Messages: Use clear and concise commit messages. Prefix your commits with tags like [Fix], [Feature], or [Docs] to indicate the nature of the change.

Testing: Ensure that your changes are properly tested. Run tests before submitting your pull request:

npm run test

Submitting a Pull Request

  1. Push to GitHub: Push your feature branch to GitHub:
git push origin your-feature-branch

  1. Open a Pull Request: Go to the original repository on GitHub and click the "Compare & pull request" button. Provide a detailed description of your changes in the pull request.

  2. Review Process: One of the maintainers will review your pull request and provide feedback or merge the changes if everything looks good.

Reporting Issues

If you encounter any issues with CodeFount, feel free to open an issue here. Please include a detailed description of the problem, steps to reproduce, and any relevant screenshots or logs.

Code of Conduct

Please adhere to our Code of Conduct in all interactions within the community.

Thank You!

Your contributions help make CodeFount better! We appreciate your time and effort in improving this project. If you have any questions, feel free to reach out.