Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.71 KB
Raw

Contributing to @lambda-group/axum-js

Thank you for your interest in contributing to axum-js! Your efforts help make this project robust and a joy to use. This document provides guidelines and instructions for contributing.

📜 Code of Conduct

We uphold a certain standard of behavior in our community. Please read and adhere to our Code of Conduct to foster a positive and inclusive environment.

💻 Development Setup

  1. Clone the Repository:
git clone https://github.com/daniel-boll/axum-js.git
cd axum-js
  1. Install Dependencies:
npm install
  1. Build the Project:
npm run build

🐞 Reporting Issues

Encountered an issue? We'd like to help. Report it on the issues page with a descriptive title and clear reproduction steps to facilitate efficient troubleshooting.

🎉 Submitting Pull Requests

  1. Fork the Repository:

    • Navigate to GitHub, and fork the repository to your account.

  2. Clone Your Fork & Create a New Branch:

git clone https://github.com/<your-username>/axum-js.git
cd axum-js
git checkout -b my-feature-branch

  1. Make Your Changes:

    • Adhere to our style guide to maintain consistency across the codebase.

  2. Push Your Changes & Submit a Pull Request:

git push origin my-feature-branch
  • Navigate to the pull requests page, click on "New Pull Request", select your fork, and initiate the PR with a clear title and informative description.

Thank you for contributing to axum-js and making a difference in the community!