Support: Review StandNote

Created on 23 Dec 2020  路  6Comments  路  Source: EddieHubCommunity/support

Hi @eddiejaoude, please review my open source project -

StandNote

Web conferencing and online meetings have become the new work culture nowadays. But somewhere along the lines, we often keep missing the crux of the discussions in these online meetings, and here comes our solution - StandNote. It is your easy to use online meeting assistant that backs you up with automated meeting minutes in every conversation. It will help you save time on board meetings, team management, and customer support such that you just focus on the conversation and never miss what鈥檚 important.

StandNote also fits into the current online education scenario where most of the classes take place over online platforms like Google Meet and Zoom. We help students with quick and concise notes that help them to revise and memorize the concepts better.

Links:

https://user-images.githubusercontent.com/42115530/102979631-56ad2f00-452c-11eb-92d0-25260992d292.mp4

open source review

Most helpful comment

The project looks really good & interesting 馃憤 . I will review in a YT video or live stream in the future to get more eyes on it for you. But for now I will share some thoughts here:

  • personally I would not have a branch for each project, I would recommend to create a GitHub Org and a repo for each project (or even a mono repo would be better if you do not want to create an Org)
  • branching name casing are not consistent, I know everyone gets excited about react, but it doesn't need to have capitals
  • branching name style, the frontend project has it in the name but the other branches do not
  • team section is great, maybe show which area each team member focuses on? so if people have questions they know who to ask
  • tag/release, I suggest making a release when at a stable point even if beta
  • issue section is not being used, if your team use it, the project will be more inclusive and others will join in
  • issue + pull request template would be useful
  • GitHub Action to automate tasks - for example linting, creating release, deploying to netlify ...
  • some commits use a standard and others do not (many commits with Update README.md does not look great)

I hope that helps 馃

All 6 comments

It's great having you contribute to this project

Feel free to raise an Issue! Welcome to the community :nerd_face:

If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 馃 . Any questions let us know.

The project looks really good!
Perhaps you could link to the Github repository of the project too?

Thanks for sharing! 馃

The project looks really good!
Perhaps you could link to the Github repository of the project too?

Thanks for sharing! 馃

Thanks, @Vyvy-vi! Here's the GitHub link: https://github.com/rajat2502/StandNote

The project looks really good & interesting 馃憤 . I will review in a YT video or live stream in the future to get more eyes on it for you. But for now I will share some thoughts here:

  • personally I would not have a branch for each project, I would recommend to create a GitHub Org and a repo for each project (or even a mono repo would be better if you do not want to create an Org)
  • branching name casing are not consistent, I know everyone gets excited about react, but it doesn't need to have capitals
  • branching name style, the frontend project has it in the name but the other branches do not
  • team section is great, maybe show which area each team member focuses on? so if people have questions they know who to ask
  • tag/release, I suggest making a release when at a stable point even if beta
  • issue section is not being used, if your team use it, the project will be more inclusive and others will join in
  • issue + pull request template would be useful
  • GitHub Action to automate tasks - for example linting, creating release, deploying to netlify ...
  • some commits use a standard and others do not (many commits with Update README.md does not look great)

I hope that helps 馃

Thank you so much @eddiejaoude for the review. I and my team will surely make the changes asap. 馃槃

Reviewing on a live stream https://youtu.be/eXqqS6CRTOQ

Here are some of my thoughts:

  • looks great, amazing logo
  • Missing image in the links section https://github.com/rajat2502/StandNote#links
  • branching naming inconsistent (React-Frontend, django)
  • use PRs for all changes
  • I think it would be better to use a mono repo style, using branches for different code bases you miss out on features like CodeOwners\
  • Use GitHub Action for automation like linting
  • Code of conduct text duplicated in Contributors file
Was this page helpful?
0 / 5 - 0 ratings

Related issues

adityaraute picture adityaraute  路  5Comments

jamesgeorge007 picture jamesgeorge007  路  4Comments

plazzy99 picture plazzy99  路  4Comments

BhuvaneshHingal picture BhuvaneshHingal  路  3Comments

DoomHammer picture DoomHammer  路  4Comments