Code of Conduct in Software Development at software100.com.mm

Version Control

• commit every 15 minutes / small features
• create feature branch from dev branch
• PR to dev branch

Issues များ

Issues ရှင်းပြီးတဲ့အခါ Issue ရဲ့ comment section တွင် အောက်ပါတို့ ထည့်ပေးရန်။

• ရှင်းပြီးတဲ့ Pull Request
• ရှင်းထားတဲ့ screenshot များ ၊ ဉပမာ CRUD UI များ၊ CRUD API Postman Screenshot များ

API , RestFUL Architecture

• Module တစ်ခုတိုင်းမှာ အခြေခံ API (၅) မျိုး ရှိသင့်တယ်။
• Listing API တိုင်းမှာ Pagination, Filter နဲ့ Sorting ပါသင့်တယ်။

Basic CRUD API for a module (e.g User)

• GET api/v1/users -> Return list of users
• GET api/v1/users/{id} -> Return detail of user
• POST api/v1/users -> Create a new user
• PUT api/v1/users/{id} -> Update an existing user
• DELETE api/v1/users/{id} -> Delete an existing user

Listing API with Pagination, Filter and Sorting

• GET api/v1/users?page=1&q=Test&role_id=1&sort=created_at&order=desc

• page -> Pagination page no
• q -> Search parameter
• role_id -> filter
• sort -> sorting field

• [x] order -> ascending or descending ( asc

  desc )

UI/UX , Don’t make me think

** Listing table တိုင်းမှာ **

• last updated record ဟာ ထိပ်ဆုံးမှာ ပြထားသင့်တယ်။
• သင့်တင့်လျောက်ပတ်တဲ့ ကော်လံတိုင်းကို searchable ဖြစ်အောင် လုပ်ပေးထားပါ။
• သင့်တင့်လျောက်ပတ်တဲ့ Filter တွေ ထည့်ပေးထားရမယ်။
• pagination ကို 100 per page အများဆုံးထားရန်။ ဉပမာ။​ ->paginated([10, 25, 50, 100])

 public static function table(Table $table): Table
    {
        return $table
            ->columns([
                 TextColumn::make('id')->sortable(),
            ])
            ->filters([
                //
            ])
            ->paginated([10, 25, 50, 100])
            ->defaultSort('updated_at', 'desc') 
            ->actions([
                Tables\Actions\EditAction::make(),
            ])
            ->bulkActions([
                Tables\Actions\BulkActionGroup::make([
                    Tables\Actions\DeleteBulkAction::make(),
                ]),
            ]);
    }