Skip to content

Latest commit

 

History

History
106 lines (74 loc) · 3.53 KB

CONTRIBUTING.md

File metadata and controls

106 lines (74 loc) · 3.53 KB

Contributing to Listings Directory

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

Getting Started

  1. Fork the Repository

  2. Clone Your Fork

    • Clone the forked repository to your local machine: 
      git clone https://github.com/your-username/listings-directory.git
cd listings-directory

  3. Set Up the Development Environment

    • Make sure you have the following tools installed:
      • bun, npm or yarn
    • Install project dependencies: 
      bun install

  4. Run the Project Locally

    • Start the development server: 
      bun run dev
    • Open your browser and navigate to http://localhost:8080.

How to Contribute

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue in the GitHub Issues section with detailed information about the problem or idea.

Code Contributions

  1. Create a Branch

    • Create a new branch for your feature or bug fix: 
      git checkout -b feature/your-feature-name

  2. Write Clear Commit Messages

    • Use concise and descriptive commit messages to explain your changes.

  3. Lint and Test Your Code

    • Run linters to ensure your code adheres to the project's style guidelines: 
      bun run lint
    • If tests are available, run them before submitting your changes: 
      bun test

  4. Submit a Pull Request

    • Push your branch to your fork: 
      git push origin feature/your-feature-name
    • Open a pull request (PR) to the main branch of the original repository. Make sure to include a clear description of the changes and reference any related issues.

Writing Documentation

  • Help improve the documentation by submitting edits to the README.md or creating new files for detailed guides.
  • Use clear and simple language, and include code examples where applicable.

Suggesting Features

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct.

Additional Resources

Thank you for helping make Listings Directory better!