Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (69 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

123 lines (69 loc) · 2.03 KB

Contributing Guide

First off, thank you for taking the time to contribute. We welcome contributions of all kinds—bug fixes, new features, documentation, and ideas.

Table of Contents

Ways to Contribute

You can contribute in several ways:

  • Reporting bugs
  • Suggesting features
  • Improving documentation
  • Submitting code fixes or enhancements
  • Sharing ideas and feedback

Getting Started

1. Fork the Repository

Click the Fork button on GitHub.

2. Clone Your Fork

git clone https://github.com/elixir-cloud-aai/cloud-registry-ui.git
cd cloud-registry-ui

3. Install Dependencies

bun install

4. Run the development server

bun run dev

Development Workflow

Create a Branch

Always create a new branch for your work:

git checkout -b feature/short-description

Branch naming examples:

  • feat/add-login
  • fix/navbar-bug
  • docs/update-readme

Commit Guidelines

Please refer to [this article] for more information.(https://github.com/elixir-cloud-aai/elixir-cloud-aai/blob/dev/resources/contributing_guidelines.md#commit-messages).

Pull Request Process

  1. Ensure your branch is up to date:
git pull upstream main
  1. Push your changes to the forked repo:
git push origin your-branch-name
  1. Open a Pull Request on GitHub

Reporting Issues

When creating an issue, please include:

  • Clear title and description
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots (if helpful)
  • Environment details (OS, version, etc.)

Style Guidelines

  • Follow existing project structure
  • Keep functions small and focused
  • Add comments where necessary
  • Use meaningful variable names

Thank You

Your contributions help make this project better for everyone!