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

Update readme, add .md extension to readme #724

Closed
wants to merge 4 commits into from

Conversation

mtbChef
Copy link
Contributor

@mtbChef mtbChef commented May 30, 2024

Proposed changes

New README file for the repo/project, including new graphical banner.

Checklist

Before creating a PR, run through this checklist and mark each as complete:

  • I have read the CONTRIBUTING document
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes

@xeioex
Copy link
Contributor

xeioex commented May 30, 2024

Hi @mtbChef,

please squash the commits in a single one. (Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR)

For example, while working on the feature you have 3 commit, but you plan to squash
them into the first one. And the top 2 commits are small fixes related to the initial commit.
Do the following
git rebase -i HEAD~3
In the interactive mode replace

pick 4ed2a1b Main commit
pick 7ac9a67 Commit message #2
pick e3a1b35 Commit message #3

with

pick 4ed2a1b Main commit
squash 7ac9a67 Commit message #2
squash e3a1b35 Commit message #3

After squashing, Git will open the editor again to combine the commit messages. You can edit this to reflect the new squashed commit's message.

With a new commit history, force-push the changes to your repo/branch:
git push origin update-readme -f. After the force push this PR will be updated automatically.

@xeioex xeioex self-requested a review May 30, 2024 23:50
@mtbChef mtbChef closed this May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants