Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

60 lines (38 loc) · 2.02 KB
Raw

Contributing to DevFinder

Welcome! We appreciate your interest in contributing to DevFinder. By contributing to this project, you help make it better for everyone. Below are some guidelines to help you get started.

Code of Conduct

This project follows a Code of Conduct. By participating, you agree to uphold this code. Please report any unacceptable behavior to the project maintainers.

How Can I Contribute?

1. Reporting Bugs:

  • If you find a bug, please check the existing issues to see if it has already been reported.
  • If not, open a new issue with a clear title and detailed description of the bug, including steps to reproduce.

2. Feature Requests:

  • If you have a feature request, open an issue with a clear title and a detailed description of the proposed feature. Discuss its implementation and potential benefits.

3. Code Contributions:

  • Fork the repository and create a new branch for your contribution.
  • Ensure your code follows the project's coding standards.
  • Submit a pull request with a clear title and description of your changes.

4. Documentation:

  • Improvements to the documentation are always welcome.
  • If you find a typo or have additional information to add, submit a pull request.

Development Environment

To set up the DevFinder project locally, follow the steps outlined in the README.

Dependencies

Ensure you have Node.js installed. To install project dependencies, run:

    npm install

Running Locally

To start the development server, run:

    npm run dev

Style Guide

  • Follow the JavaScript Standard Style.
  • Use meaningful variable and function names.
  • Document your code where necessary.

Issues

If you have questions, suggestions, or encounter issues, please use the GitHub issues section.

License

By contributing to DevFinder, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing! Your support is much appreciated.