generated from DeNepo/template-markdown
-
Notifications
You must be signed in to change notification settings - Fork 0
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 #19 from HYF-Class19/filmon-group1-bio
update of our README.md file
- Loading branch information
Showing
3 changed files
with
70 additions
and
49 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
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
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,48 +1,51 @@ | ||
# (project name) | ||
|
||
<!-- describe your project --> | ||
|
||
## Getting Started | ||
|
||
<!-- a guide to using this repository --> | ||
|
||
1. `git clone [email protected]:HackYourFutureBelgium/<project-name>.git` | ||
2. `cd project-name` | ||
3. `npm install` | ||
|
||
## Code Quality Checks | ||
|
||
- `npm run format`: Makes sure all the code in this repository is well-formatted | ||
(looks good). | ||
- `npm run lint:ls`: Will lint the folder and file names in this repository to | ||
make sure they match the repo conventions. | ||
- `npm run lint:md`: Will lint all of the Markdown files in this repository and | ||
let you know if there are any style mistakes to fix. | ||
- `npm run spell-check`: Goes through all the files in this repository looking | ||
for words it doesn't recognize. Just because it says something is a mistake | ||
doesn't mean it is! It doesn't know every word in the world. You can add new | ||
correct words to the [./.cspell.json](./.cspell.json) file so they won't cause | ||
an error. | ||
|
||
## Continuous Integration (CI) | ||
|
||
When you open a PR to `main`/`master` in your repository, GitHub will | ||
automatically do a linting check on the code in this repository, you can see | ||
this in the[./.github/workflows/lint.yml](./.github/workflows/lint.yml) file. | ||
|
||
If the linting fails, you will not be able to merge the PR. You can double check | ||
that your code will pass before pushing by running `npm run lint:md` locally. | ||
|
||
## Repo Setup | ||
|
||
- Give each member _write_ access to the repo (if it's a group project) | ||
- Turn on GitHub Pages and put a link to your website in the repo's description | ||
- Turn on GitHub Actions | ||
- in the _Branches_ section of your repo's settings make sure: | ||
- The repository | ||
[requires a review](https://github.blog/2018-03-23-require-multiple-reviewers/) | ||
before pull requests can be merged. | ||
- The `master`/`main` branch must "_Require status checks to pass before | ||
merging_" | ||
- The `master`/`main` branch must "_Require require branches to be up to date | ||
before merging_" | ||
# (Group-1 Student List) | ||
|
||
--- | ||
|
||
--- | ||
|
||
## Brian Munene | ||
|
||
## [BrianMunene96](https://github.com/BrianMunene96) | [Bio](https://github.com/HYF-Class19/workflow-group1/blob/master/student-bios/brian.md) | ||
|
||
![Brian](https://avatars.githubusercontent.com/u/107561877?v=4) | ||
|
||
--- | ||
|
||
## filmon Goitom | ||
|
||
## [filmon-goitom](https://github.com/filmon-goitom) | [Bio](https://github.com/HYF-Class19/workflow-group1/blob/master/student-bios/filmonbio.md) | ||
|
||
![filmon](https://avatars.githubusercontent.com/u/107537323?s=400&u=f97d28a78e944cefe29f49f7abad9a3db9e53810&v=4) | ||
|
||
--- | ||
|
||
## Zeynep | ||
|
||
## [Melati5](https://github.com/Melati5) | [Bio](https://github.com/HYF-Class19/workflow-group1/blob/master/student-bios/melati5.md) | ||
|
||
![Melati5](https://camo.githubusercontent.com/5d5e054779fa4a50b5af60f9ce06de546dfc49e2d209386840875d544ca722eb/68747470733a2f2f69322e6d696c696d616a2e636f6d2f692f6d696c6c697965742f37352f30783431302f3566313436393736353534323766313432343633336333372e6a7067) | ||
|
||
--- | ||
|
||
## Hayko | ||
|
||
## [HaykoDevelop](https://github.com/HaykoDevelop) | [Bio](https://github.com/HYF-Class19/home/blob/main/student-bios/HaykoDevelop.md) | ||
|
||
![Hayko](https://avatars.githubusercontent.com/u/49321251?v=4) | ||
|
||
--- | ||
|
||
## Verousca | ||
|
||
## [Verousca](https://github.com/Verousca) | [Bio](https://github.com/HYF-Class19/home/blob/main/student-bios/VerouscaBio.md) | ||
|
||
![Verousca](https://github.com/HYF-Class19/home/raw/main/student-bios/images/Verousca_Img.jpeg) | ||
|
||
--- | ||
|
||
## Valeriya | ||
|
||
## [V-Valkiriya](https://github.com/V-Valkiriya) | [Bio](https://github.com/HYF-Class19/home/blob/main/student-bios/V-Valkiriya.md) | ||
|
||
![V-Valkiriya](https://avatars.githubusercontent.com/u/106891874?v=4) |