Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
128 lines (91 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

128 lines (91 loc) · 3.1 KB
Raw

🛠 Contributing to DartAPI

Thank you for considering contributing to DartAPI! 🚀
DartAPI is a lightweight FastAPI-like framework for Dart. Your contributions help improve the project and make it more useful for everyone.

📌 Getting Started

1️⃣ Fork the Repository

Click the Fork button on GitHub to create your own copy of DartAPI.

2️⃣ Clone Your Fork

Replace <your-github-username> with your actual GitHub username:

git clone https://github.com/<your-github-username>/dartapi.git
cd dartapi

3️⃣ Set Upstream (Optional)

To sync changes from the original repo, add an upstream:

git remote add upstream https://github.com/akashgk/dartapi.git
git fetch upstream
git merge upstream/main

📌 Making Changes

1️⃣ Create a New Branch

Before making changes, create a new branch:

git checkout -b feature-branch-name

2️⃣ Install Dependencies

Ensure all dependencies are installed before making changes:

dart pub get

3️⃣ Format Code

Ensure your code follows Dart style guidelines:

dart format .

4️⃣ Run Tests

Before submitting a PR, test your changes:

dart test

📌 Submitting Your Contribution

1️⃣ Commit Your Changes

git add .
git commit -m "Added feature XYZ"

2️⃣ Push to Your Fork

git push origin feature-branch-name

3️⃣ Create a Pull Request

  1. Go to DartAPI Pull Requests.
  2. Click New Pull Request.
  3. Select your feature branch.
  4. Provide a clear description of your changes.
  5. Click Create Pull Request.

📌 Contribution Guidelines

✅ Follow Best Practices

  • Use meaningful commit messages.
  • Follow Dart formatting standards (dart format .).
  • Add comments where necessary.

✅ Code Quality & Tests

  • Ensure your code is well-structured and documented.
  • If you add a feature, include unit tests (dart test).

✅ Pull Request Etiquette

  • Keep PRs small and focused (one feature or bug fix per PR).
  • Provide clear descriptions in PRs.

📌 Reporting Issues & Feature Requests

1️⃣ Reporting Bugs

If you find a bug, please open an issue:

  • Describe what happens vs. what you expected.
  • Provide steps to reproduce.
  • Attach logs/screenshots if possible.

📝 Open an Issue

2️⃣ Requesting a Feature

To request a new feature:

📌 Community & Support

💬 Join the Discussion

💙 Thank You for Contributing!
DartAPI is open-source, and we appreciate all contributions! 🚀