Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 4.07 KB

CONTRIBUTING.md

File metadata and controls

98 lines (69 loc) · 4.07 KB

Contributing to Shelve

Thank you for your interest in contributing to Shelve! We welcome contributions from the community and are excited to work with you. Please follow the guidelines below to ensure a smooth and effective contribution process.

Contribution Guidelines

Reporting Issues

If you encounter any issues or bugs while using Shelve, please report them by opening an issue on our GitHub Issues page. Provide as much detail as possible, including steps to reproduce the issue, screenshots, and any relevant error messages.

Suggesting Features

We welcome feature suggestions and ideas to improve Shelve. To suggest a new feature, please open an issue on our GitHub Issues page and provide a clear description of the feature, its benefits, and any potential use cases.

Development Setup

Monorepo Structure

Shelve uses a monorepo structure to manage multiple packages and applications. The main packages are:

  • apps/shelve: The main Shelve application.
  • apps/lp: The landing page for Shelve.
  • apps/base: This is the base layer that contains the shared configuration lp and shelve (components, plugins, etc).
  • packages/cli: The CLI connected to the Shelve application (push, pull, etc).
  • packages/crypto: The encryption and decryption package.
  • packages/types: The shared types inside the monorepo.
  • packages/utils: The shared utilities inside the monorepo.

The monorepo is managed utilizing Turborepo. With Turborepo, it is possible to execute commands across all packages or target specific packages. Consequently, you will primarily operate from the root of the repository and execute commands such as bun dev:app to initiate the Shelve application.

Necessary Environment Variables

  • DATABASE_URL (PostgreSQL)
  • NUXT_OAUTH_GITHUB_CLIENT_ID (or google)
  • NUXT_OAUTH_GITHUB_CLIENT_SECRET (or google)
  • NUXT_PRIVATE_REDIS_URL (only for production)
  • NUXT_PRIVATE_ENCRYPTION_KEY

To set up the development environment for Shelve, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/HugoRCD/shelve.git
cd shelve

  2. Install Dependencies:

    bun install

  3. Copy the Example Environment File:

    cp apps/shelve/.env.example apps/shelve/.env

  4. Update Environment Variables: Edit the apps/shelve/.env file and update the necessary environment variables.

  5. Start the Development Server:

    bun dev:app

PR Process

  1. Fork the Repository: Create a fork of the Shelve repository on GitHub.

  2. Create a Branch: Create a new branch for your feature or bugfix. Use a descriptive name for the branch, such as feat/add-new-feature or fix/issue-123.

  3. Make Changes: Make your changes in the new branch. Ensure that your code follows the project's coding standards and conventions.

  4. Commit Changes: Commit your changes with a clear and descriptive commit message. Follow the Conventional Commits specification.

  5. Push Changes: Push your changes to your forked repository.

  6. Create a Pull Request: Create a pull request (PR) from your forked repository to the main Shelve repository. Provide a detailed description of your changes and any relevant information.

  7. Address Feedback: Be responsive to feedback and comments on your PR. Make any necessary changes and update your PR accordingly.

Code Style Guide

  • Follow the existing code style and conventions, the project use the @hrcd/eslint-config ESLint configuration.
  • Use meaningful variable and function names.
  • Write clear and concise comments where necessary.
  • Ensure your code is well-documented.

Additional Resources

Thank you for contributing to Shelve! We appreciate your support and look forward to your contributions.