forked from MIT-Emerging-Talent/ET6-practice-code-review
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from MIT-Emerging-Talent/update-general-README
Update general readme
- Loading branch information
Showing
2 changed files
with
123 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,123 @@ | ||
# Coding Pioneers United - Team repository | ||
|
||
![technology Python](https://img.shields.io/badge/technology-python-blue.svg) | ||
|
||
Welcome to our team! Our group thrives on mutual trust, open communication, and | ||
respect, fostering a collaborative environment where every member’s ideas and | ||
contributions are valued. We aim to work efficiently and harmoniously by balancing | ||
creativity and critical thinking, supporting one another to achieve our shared goals | ||
while maintaining a culture of accountability and care. | ||
|
||
## Meet the team | ||
|
||
<!-- markdownlint-disable MD033 --> | ||
<table> | ||
<thead> | ||
<tr> | ||
<th></th> | ||
<th><strong>Name</strong></th> | ||
<th><strong>GitHub</strong></th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td> | ||
<img src="https://avatars.githubusercontent.com/u/189562848?v=4" | ||
alt="Ana Isabel Murillo" width="50"> | ||
</td> | ||
<td>Ana Isabel Murillo</td> | ||
<td><a href="https://github.com/AnaiMurillo">AnaiMurillo</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/188538629?v=4" | ||
alt="Chrismy Augustin" width="50"></td> | ||
<td>Chrismy Augustin</td> | ||
<td><a href="https://github.com/likechrisss">likechrisss</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/92646899?v=4" | ||
alt="Cliforde Exael" width="50"></td> | ||
<td>Cliforde Exael</td> | ||
<td><a href="https://github.com/Lastrophysicien">Lastrophysicien</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/115899276?v=4" | ||
alt="Hector Colmenares" width="50"></td> | ||
<td>Hector Colmenares</td> | ||
<td><a href="https://github.com/hectordacb">hectordacb</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/189242306?v=4" | ||
alt="Jeampierr Jiménez" width="50"></td> | ||
<td>Jeampierr Jiménez</td> | ||
<td><a href="https://github.com/Jeampierr1102">Jeampierr1102</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/86928180?v=4" | ||
alt="Ramon Colmenares" width="50"></td> | ||
<td>Ramon Colmenares</td> | ||
<td><a href="https://github.com/RamonColmenares">RamonColmenares</a></td> | ||
</tr> | ||
<tr> | ||
<td><img src="https://avatars.githubusercontent.com/u/189634607?v=4" | ||
alt="Semira Tesfai" width="50"></td> | ||
<td>Semira Tesfai</td> | ||
<td><a href="https://github.com/SEMIRATESFAI">SEMIRATESFAI</a></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
<!-- markdownlint-enable MD033 --> | ||
|
||
## Project Progress | ||
|
||
We track our progress using the | ||
[GitHub Kanban Board](https://github.com/orgs/MIT-Emerging-Talent/projects/104). | ||
Here's a quick look at our board in action: | ||
|
||
![Kanban Board Preview](assets/kabanboard04.gif) | ||
|
||
## Technologies & Tools 🛠️ | ||
|
||
- **Languages:** Python | ||
- **Frameworks/Libraries:** Unittest | ||
- **Documentation:** Markdown | ||
- **Version Control:** Git, GitHub | ||
- **Other Tools:** VS Code | ||
|
||
## Getting Started 🚀 | ||
|
||
Before cloning this repository, make sure you have Git | ||
installed and are signed into your GitHub account. | ||
|
||
### Clone the Repository | ||
|
||
1. Open your terminal (Command Prompt, Git Bash, or terminal of choice). | ||
|
||
2. Clone the repository using either SSH or HTTPS. | ||
|
||
**Using SSH**: | ||
|
||
```bash | ||
git clone [email protected]:MIT-Emerging-Talent/ET6-foundations-group-04.git | ||
``` | ||
|
||
### Run the Tests | ||
|
||
1. Open your terminal (Command Prompt, Git Bash, or terminal of choice). | ||
|
||
2. Navigate to the project directory: | ||
|
||
```bash | ||
cd ET6-foundations-group-04 | ||
``` | ||
|
||
3. Run the tests using: | ||
|
||
```bash | ||
python -m unittest | ||
``` | ||
|
||
## Contributing | ||
|
||
Please refer to our [Contributing Guide](CONTRIBUTING.md) for information | ||
on how to contribute to this project. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.