Skip to content

Commit

Permalink
updated coc
Browse files Browse the repository at this point in the history
  • Loading branch information
saropa committed Oct 22, 2024
1 parent dd8d191 commit cb5f467
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 8 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

* 🤝 Updated code.of.conduct.md with saropa logo

Check warning on line 5 in CHANGELOG.md

View workflow job for this annotation

GitHub Actions / spell-check / build

Unknown word (saropa)
* 🤝 Updated code.of.conduct.md with examples, a survey and an exercise
* 🧹 Rename `doc` output folder to `docs`

## 0.2.3+Pittsburgh

Expand Down
14 changes: 8 additions & 6 deletions code.of.conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ Saropa is committed to diversity and equal opportunity. We do not discriminate b

*Unacceptable behavior includes:*

- Use of sexualized language or imagery and other harassment, including trolling, insults, and derogatory comments
- Use of sexualized language or imagery, trolling, or derogatory comments
- Publishing others' private information without permission
- Any inappropriate conduct in a professional setting

This Code of Conduct applies within project spaces and public spaces when representing the project or community. This includes using official emails, social media accounts, or acting as an official representative.

Report unacceptable behavior to the project team at [[email protected]]([email protected]). All complaints will be reviewed and investigated confidentially. Maintainers who fail to enforce the Code of Conduct may face repercussions as determined by the project's leadership.
Report unacceptable behavior to the project team at [[email protected]]([email protected]). All complaints will be reviewed and investigated confidentially. Failure to enforce the Code of Conduct may result in repercussions as determined by the project's leadership.

### We Start Now

Expand Down Expand Up @@ -122,9 +122,9 @@ Bad coding is easy. The following rules make code simpler to read, review, maint

1.1.b 📐 Maintain a separation of concerns. Small files and functions streamline code reviews, migrations and merges.

- Separate UI, models, services, and utilities into distinct folders, with patterns like MVVM or Clean Architecture.
- Separate UI, models, services, and utilities into distinct folders, with patterns like `MVVM` or `Clean Architecture`.
- Keep state management logic separate from UI code, to ensure state changes are predictable and testable.
- Organize files by feature or module, named based on their functionality (e.g., `user_profile.code`)
- Organize files by feature or module, named based on their functionality

1.1.c 🎯 Exit early to avoid nested ifs and separate logic into methods

Expand Down Expand Up @@ -478,7 +478,7 @@ Focus on ethical practices, managing stress, identifying and handling risks, fos

7.3.e ❓ Experienced people ask questions. "I got this" is good, but "I don't know" is crucial for growth.

7.3.f 🔨 Slow progress is only bad if not communicated. Refusing to feedback bad news is not a successful strategy, instead ask for creative solutions.
7.3.f 🔨 Slow progress is only bad when not communicated. Refusing to feedback bad news is neither a successful or rewarded strategy, instead ask stakeholders for creative solutions.

### Respect Flow State

Expand Down Expand Up @@ -566,7 +566,9 @@ Choose 1 only...

## The Exercise

Imagine you are part of a development team tasked with improving an existing task management system. Your goal is to propose new features that enhance the system's usability, performance, and overall effectiveness. We’re looking for people who can think outside the box, deliver high-quality work quickly, and inspire innovation in our task management system.
Imagine you are part of a development team tasked with improving an existing task management system. Your goal is to propose new features that enhance the system's usability, performance, and overall effectiveness.

We’re looking for people who can think outside the box, deliver high-quality work quickly, and inspire innovation in our task management system.

1. 🛠️ How would we identify a high-quality feature that is missing?
1. 📊 What is an interesting idea to report task progress to users?
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: saropa_dart_utils
description: "Boilerplate reduction tools and human readable extension methods by Saropa"
version: 0.3.1+Jakarta
version: 0.3.2+Jakarta

homepage: https://app.saropa.com
repository: https://github.com/saropa/saropa_dart_utils
Expand Down
2 changes: 1 addition & 1 deletion scripts/flutter_generate_docs.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ $workingDir = Split-Path -Path $scriptDir -Parent
Set-Location -Path $workingDir

# Define the documentation output directory
$docOutputDir = Join-Path $workingDir "doc"
$docOutputDir = Join-Path $workingDir "docs"

# Clean the documentation directory
if (Test-Path $docOutputDir) {
Expand Down

0 comments on commit cb5f467

Please sign in to comment.