Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
AmadeusK525 opened this issue Jan 6, 2023 · 0 comments · May be fixed by #8
Open

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

AmadeusK525 opened this issue Jan 6, 2023 · 0 comments · May be fixed by #8
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@AmadeusK525
Copy link
Collaborator

AmadeusK525 commented Jan 6, 2023

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:

@AmadeusK525 AmadeusK525 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jan 6, 2023
@lfjnascimento lfjnascimento self-assigned this Mar 14, 2024
lfjnascimento added a commit that referenced this issue May 15, 2024
Add a concise description of the services provided by ProFUSION,
as well as links and emails for contacts.

Closes #5
@lfjnascimento lfjnascimento linked a pull request May 15, 2024 that will close this issue
lfjnascimento added a commit that referenced this issue May 28, 2024
Add a concise description of the services provided by ProFUSION,
as well as links and emails for contacts.

Closes #5
lfjnascimento added a commit that referenced this issue May 28, 2024
Add a concise description of the services provided by ProFUSION,
as well as links and emails for contacts.

Closes #5
lfjnascimento added a commit that referenced this issue May 28, 2024
Add a concise description of the services provided by ProFUSION,
as well as links and emails for contacts.

Closes #5
lfjnascimento added a commit that referenced this issue May 28, 2024
Add a concise description of the services provided by ProFUSION,
as well as links and emails for contacts.

Closes #5
lfjnascimento added a commit that referenced this issue May 28, 2024
Add a concise description of the services provided by ProFUSION,
as well as links and emails for contacts.

Closes #5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants