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

🎨 Redesigned Banner for README.md and Updated Project Documentation #22

Closed
sudo-parnab opened this issue Oct 12, 2024 · 0 comments · Fixed by #42
Closed

🎨 Redesigned Banner for README.md and Updated Project Documentation #22

sudo-parnab opened this issue Oct 12, 2024 · 0 comments · Fixed by #42
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest-accepted Hacktoberfest 2024 accepted PR help wanted Extra attention is needed

Comments

@sudo-parnab
Copy link
Owner

1. Designing the Banner

  • Create a more visually appealing banner for the README.md file. As this is a task for designers, ensure the banner is professional, on-brand, and enhances the project's theme.
  • Suggested design tools: Figma, Adobe Illustrator, Canva, or any tool of your choice.
  • Export the banner in a common web format, preferably .png or .jpg.

2. Adding the Banner to the Code Repository

  • Save the new banner image in the main code folder (do not create a new folder).
  • Update the README.md to reference the new image. Use the following markdown syntax:
    ![Banner](./your-banner-file-name.png)
  • Ensure the banner path is correct relative to the location of the README.md file.

3. Create a New Pull Request (PR)

  • Branch: Ensure you are working on a new branch dedicated to this change (e.g., banner-redesign).
  • Commit Message: Write a descriptive commit message. Example:
    Redesigned banner and updated README.md
    
  • PR Template: When creating the pull request, select the New Project option from the template.
  • Follow PR Guidelines: Ensure you follow other project guidelines, such as adding a clear description of what changes you made, linking any relevant issues, and tagging any reviewers.
@sudo-parnab sudo-parnab added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest-accepted Hacktoberfest 2024 accepted PR labels Oct 12, 2024
@us107 us107 mentioned this issue Oct 18, 2024
6 tasks
@sudo-parnab sudo-parnab linked a pull request Oct 18, 2024 that will close this issue
6 tasks
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 enhancement New feature or request good first issue Good for newcomers hacktoberfest-accepted Hacktoberfest 2024 accepted PR help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant