Skip to content

Latest commit

 

History

History
138 lines (90 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

138 lines (90 loc) · 2.94 KB

Contributing to Rust Nigeria Website

Thank you for your interest in contributing to the Rust Nigeria website! This document will guide you on how to set up the project, submit changes, and ensure a smooth contribution process.

Table of Contents

  1. How to Contribute
  2. Project Setup
  3. Coding Standards
  4. Submitting Changes
  5. Reporting Issues
  6. Additional Resources

How to Contribute

There are several ways you can contribute:

  • Reporting bugs or issues
  • Suggesting new features
  • Submitting pull requests with code or content improvements
  • summiting project,event or blog post
  • Improving documentation or design

Please follow the guidelines below to make your contribution process smooth.

Project Setup

Using Just

  1. Install required tools:

    cargo install cargo-leptos
cargo install just

  2. Build the site:

    just setup

  3. Start the site locally:

    just start

  4. Open your browser at: http://localhost:3000

Using Docker

  1. Install Docker: Docker Installation Guide

  2. Clone the repository:

    git clone [email protected]:Rust-Nigeria/website.git
cd website

  3. Build the Docker image:

    docker build -t rust-nigeria-website .

  4. Run the Docker container:

    docker run -p 3000:8080 rust-nigeria-website

  5. Open your browser at: http://localhost:3000

Coding Standards

  • Styling: TailwindCSS and Sass are used for styling.

    • Tailwind classes autocomplete is enabled in VSCode.

  • HTML/Leptos: Follow existing component structure.

  • Commit messages: Use clear, concise messages that describe your changes.

  • Ensure you run rustc cargo_tool.rs and ./cargo_tool.exe for windows or ./cargo_tool linux and mac before sending a PR

Submitting Changes

  1. Fork the repository and create a feature branch:

    git checkout -b <my-feature-branch>

  2. Make your changes locally and test them.

  3. Commit your changes:

    git commit -m "Add meaningful description of change"

  4. Push your branch and open a pull request against the dev branch.

Reporting Issues

If you encounter any bugs or issues:

  1. Check existing issues to avoid duplicates.

  2. Open a new issue with:

    • Clear title
    • Steps to reproduce
    • Screenshots or links if applicable

Additional Resources