Skip to content

feat: create README.md for ProFUSION's GitHub page #5

@AmadeusK525

Description

@AmadeusK525

Description

This repository is special, as GitHub shares its properties (like PR templates) across different repos in ProFUSION's
ownership. This also happens with the README.md file, which will appear in the main page of PF's profile here on GitHub. With that, we need to write a good portfolio-like file that will be visible to anyone on GitHub.

Implementation details

Since the file will be public, we can't link to any private repos. Instead, we should detail things like:

  • Our work ethic
  • Mention some projects we've worked on
  • Link our developer's profiles (maybe? may be hard to keep track, remove/add profiles as the team changes...)
  • Mention technologies we excel in
  • Use attractive graphs/images/gifs/animations in the file, like the best GitHub profiles do

These aren't hard points, all of this should be discussed with other employees (or employers) to make this a shared effort

Potential caveats

Any little point that you're not sure can be shared in public needs to be addressed first. Get confirmation with @barbieri or @bdilly BEFORE pushing your changes to the remote (even if it's a wip).

Needless to say, Both Barbieri and Dilly should approve the file for it to be merged

Additional context and visual reference

GitHub article explaining how to create the README.md

Here are some cool profiles from some of our developers that can serve as inspiration:

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationhelp wantedExtra attention is needed

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions