forked from MIT-Emerging-Talent/ET6-practice-code-review
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into Constraints
- Loading branch information
Showing
4 changed files
with
154 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,19 +4,19 @@ on: [push, pull_request, workflow_dispatch] | |
|
||
jobs: | ||
ls_linting: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: ls-lint/[email protected] | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: ls-lint/[email protected] | ||
|
||
md_formatting: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: nosborn/[email protected] | ||
with: | ||
files: . | ||
config_file: .markdownlint.yml | ||
- uses: actions/checkout@v4 | ||
- uses: nosborn/[email protected] | ||
with: | ||
files: . | ||
config_file: .markdownlint.yml | ||
|
||
py_formatting: | ||
runs-on: ubuntu-latest | ||
|
@@ -50,14 +50,20 @@ jobs: | |
- name: Python - Check Linting - pylint | ||
run: "pylint solutions tests || echo '::warning title=Pylint Error(s)::Discuss solutions and trade-offs in code review.'" | ||
shell: bash | ||
|
||
py_tests: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: python version | ||
run: python --version | ||
shell: bash | ||
- name: Python - Run Tests | ||
run: python -m unittest | ||
shell: bash | ||
py_tests: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Check for Non-Markdown Changes | ||
run: | | ||
if ! git diff --name-only HEAD^1 | grep -E -v '\.md$'; then | ||
echo "Only Markdown files changed. Skipping tests." | ||
exit 0 | ||
fi | ||
shell: bash | ||
- name: python version | ||
run: python --version | ||
shell: bash | ||
- name: Python - Run Tests | ||
run: python -m unittest | ||
shell: bash |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,39 @@ | ||
ignore: | ||
- venv | ||
- .github | ||
# Focuses on core readability and consistency practices | ||
|
||
# Headings | ||
MD003: # Heading style | ||
style: consistent | ||
MD004: # Unordered list style | ||
style: consistent | ||
MD007: # Unordered list indentation | ||
indent: 2 | ||
|
||
# Line length and whitespace | ||
MD013: # Line length | ||
line_length: 8000 | ||
strict: false | ||
stern: false | ||
|
||
# Spacing and formatting | ||
MD022: # Headings should be surrounded by blank lines | ||
lines_above: 1 | ||
lines_below: 1 | ||
MD023: # Headings must start at the beginning of the line | ||
MD030: # Spaces after list markers | ||
ul_single: 1 | ||
ol_single: 1 | ||
ul_multi: 1 | ||
ol_multi: 1 | ||
|
||
# Emphasis and strong | ||
MD036: # Emphasis used instead of a heading | ||
punctuation: ".,;:!?" | ||
|
||
# General best practices | ||
MD047: true # Files should end with a single newline character | ||
MD048: # Code block style (consistent backticks) | ||
style: consistent | ||
|
||
# Disable some strict rules for beginners | ||
MD024: false # Allow multiple headings with the same content | ||
MD041: false # First line in a file being a top-level heading |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,86 @@ | ||
# Collaboration | ||
|
||
# 🌟 Our Group Norms | ||
<!-- group norms summary --> | ||
|
||
## ✨ Summary | ||
|
||
Our group norms emphasize **availability**, **trust**, **inclusivity**, and **adaptability** as cornerstones of effective collaboration. Trust is built through reliability, empathy, and accountability, fostering both cognitive and affective connections. Clear communication, respect, and time management ensure productive teamwork, while flexibility allows us to adapt to individual needs and project demands. Leadership is approached collaboratively, and norms evolve to maintain relevance, supported by thorough documentation and consistent standards. | ||
|
||
--- | ||
<!-- group norms list --> | ||
## 📋 Group Norms | ||
|
||
### 🕒 Availability | ||
|
||
- **We will ensure availability** by committing to being accessible from afternoon to early evening in our local time zones, which aligns with **7 am to 1 pm EST**. | ||
|
||
### 🤝 Trust | ||
|
||
- **Cognitive Trust**: | ||
We will consistently deliver quality work, meet deadlines, and communicate effectively. Reliability and competence will form the foundation of trust in each other’s abilities. | ||
- **Affective Trust**: | ||
We will cultivate trust by building personal connections through empathy, active listening, and support during challenges. Transparency, constructive feedback, and approachability will be key. | ||
- **Addressing Damaged Trust**: | ||
Mistakes will be acknowledged with sincerity, responsibility will be taken, and open communication will be used to restore confidence. | ||
|
||
### 💬 Discussion & Debate | ||
|
||
- **We will balance discussion and debate** by using each appropriately: | ||
- *Discussion*: For collaborative brainstorming, sharing diverse perspectives, and fostering inclusivity. | ||
- *Debate*: For resolving disagreements or evaluating competing ideas. | ||
|
||
### 🙌 Respect | ||
|
||
- We will ensure **mutual respect** by actively listening, giving constructive feedback, and recognizing contributions. | ||
- Disrespect, such as interruptions or dismissive behavior, will be avoided to maintain a positive group dynamic. | ||
|
||
### 🌍 Inclusivity | ||
|
||
- **We will foster inclusivity** by creating an environment where all voices are heard and valued. Respect for diverse perspectives and communication styles will ensure everyone feels included. | ||
|
||
### 🔄 Flexibility & Adaptability | ||
|
||
- **We will remain flexible** by adjusting to individual circumstances and evolving group norms as needed. Feedback and project demands will guide these changes. | ||
|
||
### 📢 Communication | ||
|
||
- **We will prioritize clear communication** through: | ||
- Slack for quick updates. | ||
- Email for formal documentation. | ||
- Virtual meetings for discussions and decisions. | ||
- Agendas will keep meetings focused, and open discussions will encourage collaboration. | ||
|
||
### ⏰ Time Management | ||
|
||
- **We will respect schedules and deadlines** by: | ||
- Allowing a 10-minute grace period for late arrivals. | ||
- Using pre-set agendas for productive meetings. | ||
- Coming prepared with completed tasks. | ||
|
||
### 🗳️ Decision-Making | ||
|
||
- **We will strive for consensus** and use majority votes when disagreements arise. | ||
- Major decisions will be documented and shared transparently. | ||
|
||
### 🛠️ Task Division & Collaboration | ||
|
||
- **Tasks will be divided fairly** using a "divide and conquer" approach to ensure equal contributions. | ||
- Progress will be tracked to maintain accountability, and contributions will be respected regardless of task complexity. | ||
|
||
### 🔗 Leadership | ||
|
||
- **We will handle leadership flexibly** by assigning leaders as needed or sharing responsibilities among all members. | ||
|
||
### 💡 Conflict Resolution | ||
|
||
- **We will address conflicts with openness and empathy**, focusing on collaborative resolutions. Mistakes will be acknowledged, and trust will be restored through accountability and dialogue. | ||
|
||
### 🚀 Norm Evolution | ||
|
||
- **We will review and adapt norms** regularly as the team grows and challenges arise to keep them relevant and effective. | ||
|
||
### 📝 Documentation & Coding Standards | ||
|
||
- **We will maintain thorough documentation** of contributions, decisions, and progress. | ||
- Coding standards will include consistent templates and camelCase naming conventions for variables and functions. | ||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Creating a local branch | ||
|
||
you can follow this procedure to create a local branch. | ||
|
||
1 | ||
updating py_test |