Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

72 lines (50 loc) · 2.55 KB

Contributing to Medium-Blog

We're excited that you're interested in contributing to Medium-Blog. This document outlines the process for contributing to our project and provides some guidelines to ensure a smooth collaboration.

Table of Contents

  1. Project Structure
  2. Getting Started
  3. Raising Issues
  4. Submitting Pull Requests
  5. Code Style and Standards
  6. Security Considerations

Project Structure

Our project is structured as follows:

  • Frontend: Built with Vite and React
  • Backend: Built with Hono.js

Please familiarize yourself with these technologies before contributing.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Install the necessary dependencies for both frontend and backend.
  4. Create a new branch for your feature or bug fix.

Raising Issues

When raising an issue, please follow these guidelines:

  1. Check if the issue already exists in the project's issue tracker.
  2. If it doesn't exist, create a new issue with a clear, descriptive title.
  3. Provide a detailed description of the issue, including:
    • Steps to reproduce
    • Expected behavior
    • Actual behavior
    • Screenshots or error messages (if applicable)
  4. Label the issue appropriately (e.g., bug, enhancement, documentation).

Submitting Pull Requests

To submit a pull request (PR):

  1. Write clear, concise commit messages.
  2. Include tests for new features or bug fixes.
  3. Update documentation if necessary.
  4. Create a pull request with a clear title and description.
  5. Reference any related issues in your PR description.

Code Style and Standards

  • Follow the existing code style in the project.
  • Use meaningful variable and function names.
  • Write clear comments for complex logic.
  • Ensure your code is properly formatted.

Security Considerations

When contributing, please keep the following security considerations in mind:

  1. Never commit sensitive information (e.g., API keys, passwords) to the repository.
  2. Use environment variables for configuration settings.
  3. Validate and sanitize user inputs to prevent injection attacks.
  4. Follow best practices for authentication and authorization.
  5. Keep dependencies up to date and regularly check for vulnerabilities.

For any security-related issues, please report them privately to the project maintainers.

Thank you for contributing to Medium-Blog Your efforts help make this project better for everyone.