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

[FEATURE] Add project icon #70

Open
4 tasks
guibranco opened this issue Oct 22, 2023 · 0 comments
Open
4 tasks

[FEATURE] Add project icon #70

guibranco opened this issue Oct 22, 2023 · 0 comments
Labels
📝 documentation Tasks related to writing or updating documentation enhancement New feature or request gitauto GitAuto label to trigger the app in a issue.

Comments

@guibranco
Copy link
Member

guibranco commented Oct 22, 2023

Description:

Add a project-specific icon to the repository to visually represent the project across GitHub and related platforms. The project icon helps with branding and improves recognition in the repository list, issues, pull requests, and project dashboard.

Tasks:

  1. Design/Select Icon:

    • Create or select an appropriate project icon that visually represents the project and fits GitHub's image requirements.
    • The icon should be relevant to the project's purpose and align with any existing branding guidelines (if applicable).
  2. Add Icon to Repository:

    • Add the project icon to the root directory of the repository or to a designated folder (e.g., assets or images).
    • Ensure the icon file format is appropriate (e.g., .png, .svg) and that the image has sufficient resolution for visibility across platforms.
  3. Update README (Optional):

    • Optionally, include the icon in the README.md file for better project recognition.
    • Example:
    ![Project Icon](./assets/project-icon.png)
  4. Configure GitHub Settings (Optional):

    • Optionally, set the icon in the GitHub project settings to ensure it displays as the repository's logo.

Acceptance Criteria:

  • A project icon is created or selected and added to the repository.
  • The icon file is appropriately placed in the repository, with correct file type and resolution.
  • (Optional) The README.md file is updated to display the project icon.
  • (Optional) The project icon is set in the GitHub repository settings.

Additional Context:

Having a project icon enhances the repository's appearance and makes it easier to identify in project lists and on the dashboard. It also improves branding and gives the project a more professional and polished look.

@guibranco guibranco added 📝 documentation Tasks related to writing or updating documentation enhancement New feature or request labels Oct 22, 2023
@guibranco guibranco self-assigned this Oct 22, 2023
@guibranco guibranco removed their assignment Mar 21, 2024
@guibranco guibranco changed the title Add project icon [FEATURE] Add project icon May 15, 2024
@gitauto-ai gitauto-ai bot added the gitauto GitAuto label to trigger the app in a issue. label Jul 9, 2024
@InovacaoMediaBrasil InovacaoMediaBrasil deleted a comment from gitauto-ai bot Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 documentation Tasks related to writing or updating documentation enhancement New feature or request gitauto GitAuto label to trigger the app in a issue.
Projects
None yet
Development

No branches or pull requests

1 participant