Skip to content

Latest commit

 

History

History
151 lines (101 loc) · 4.58 KB

CONTRIBUTING.md

File metadata and controls

151 lines (101 loc) · 4.58 KB

Contributing Guidelines

Thank you for your interest in contributing to DeReview! We welcome contributions from the community to help us improve and grow. This document outlines the process for contributing to our project.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand the expectations for all contributors.

How Can I Contribute?

Reporting Bugs

If you find a bug or an issue, please:

  1. Search Existing Issues: Before creating a new issue, check if one already exists to avoid duplicates.
  2. Create a Detailed Issue: If no existing issue is found, open a new issue with:
    • A descriptive title.
    • Steps to reproduce the issue.
    • Expected and actual behavior.
    • Screenshots or logs, if applicable.
  3. Label Appropriately: Use appropriate labels (e.g., bug, enhancement) to categorize the issue.

Suggesting Enhancements

We welcome ideas to improve DeReview. To suggest an enhancement:

  1. Check for Existing Suggestions: Ensure your idea hasn't already been proposed.
  2. Open an Issue: Create a new issue with:
    • A clear and descriptive title.
    • Detailed explanation of the enhancement.
    • Benefits and potential drawbacks.
    • Any relevant examples or references.

Submitting Pull Requests

We appreciate pull requests! Here's how to submit one:

  1. Fork the Repository: Create a personal fork of the repository.
  2. Create a Branch: Use a descriptive name (e.g., feature/add-login, bugfix/fix-typo).
  3. Make Changes: Implement your changes, ensuring they align with our Style Guidelines.
  4. Write Tests: If applicable, write tests to cover your changes.
  5. Commit Changes: Use clear and descriptive commit messages.
  6. Push to Your Fork: Push the branch to your forked repository.
  7. Open a Pull Request:
    • Provide a clear description of your changes.
    • Reference any related issues.
    • Request a review from the maintainers.

Note: Ensure your branch is up-to-date with the main branch to avoid merge conflicts.

Development Setup

To set up a local development environment:

  1. Clone the Repository:

    git clone https://github.com/dereview/dereview-app.git

  2. Install Dependencies:

    npm install

  3. Start the Development Server:

    npm run dev

  4. Run Tests (if applicable):

    npm test

Style Guidelines

Consistency is key for maintainable code. Please adhere to the following guidelines:

  • Coding Standards: Follow the coding conventions used in the existing codebase.
  • Formatting: Use the project's configured linters and formatters (e.g., ESLint, Prettier).
  • Comments: Write clear and concise comments where necessary.
  • Documentation: Update or add documentation for new features or changes.
  • Languages: Ensure code is written in English.

Commit Messages

Write clear and descriptive commit messages:

  • Format: Use the imperative mood (e.g., "Add feature", "Fix bug").
  • Structure:
    • Title: Brief summary of the changes (50 characters max).
    • Body (optional): Detailed explanation, if necessary.
  • References: Mention related issue numbers (e.g., Fixes #123).

Issue Tracking

We use GitHub Issues for tracking:

  • Labels: Apply appropriate labels to categorize issues.
  • Assignees: If you're working on an issue, assign it to yourself.
  • Milestones: Link issues to milestones, if applicable.

Community Support

  • Discussions: Use the GitHub Discussions tab for general questions and community interactions.
  • Slack Channel: Join our Slack channel at #dereview-community for real-time conversations.
  • Email: For sensitive topics, email us at contact@dereview.org.

License

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

Thank you for contributing to DeReview! Your efforts help us build a transparent and trustworthy platform.