Skip to content
This repository has been archived by the owner on Nov 5, 2024. It is now read-only.

Issue 3270 - CONTRIBUTING.md fixes and readability enhancements #3306

Merged
merged 3 commits into from
Jul 8, 2024

Conversation

CodinGeo
Copy link
Contributor

@CodinGeo CodinGeo commented Jul 8, 2024

Pull Request (PR) Checklist

Please check if your pull request fulfills the following requirements:

  • [✅] The PR is submitted to the main branch.
  • [✅] I've read the Contribution Guidelines and my PR doesn't break the rules.
  • [✅] I've read and understand the Developer Guidelines.
  • [✅] I confirm that I've run the code locally and everything works as expected.
  • [✅] 🎬 I've attached a screen recoding of the changes.
  • [✅] My PR includes only the necessary changes to fix the issue (i.e., no unnecessary files or lines of code are changed).

What's changed?

Before:
image
image
image
image

After:
image
image
image

Describe with a few bullets what's new:

  • Texts were made simpler and easier to read
  • I've deleted some of the more graphic things (like forking badge) in order to make the ⚠️ icons more visible.
  • I've changed place of some info in order to keep them in one place based on their topic
  • Forking part was moved after finding an issue

Risk Factors

What may go wrong if we merge your PR?

  • Some people may not like the design, but I think the content is now much easier to follow.

In what cases your code won't work?

  • I don't see any, it's a .md file for developers ;)

Does this PR closes any GitHub Issues?

Check Ivy Wallet Issues.

Troubleshooting CI failures ❌

GitHub Actions failing? Read our CI Troubleshooting guide.

Copy link
Collaborator

@ILIYANGERMANOV ILIYANGERMANOV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @CodinGeo let's:

  1. Move forking as first and bring back the graphic badge
  • Forks leads to repo SEO, popularity and stats
  • Once a person forks they're more likely to contribute

CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ILIYANGERMANOV ILIYANGERMANOV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work 👏

CONTRIBUTING.md Outdated Show resolved Hide resolved
@ILIYANGERMANOV ILIYANGERMANOV added the keep Keep it from automatically getting closed by Stale label Jul 8, 2024
@CodinGeo
Copy link
Contributor Author

CodinGeo commented Jul 8, 2024

@ILIYANGERMANOV There is no other way to change such simple things like this arrow without just commiting, right?

@ILIYANGERMANOV
Copy link
Collaborator

@ILIYANGERMANOV There is no other way to change such simple things like this arrow without just commiting, right?

Each change, even 1 symbol requires a commit. GIT uses an immutable history where each change is a commit (similarly to blockchain)

@ILIYANGERMANOV ILIYANGERMANOV merged commit c61d0c8 into Ivy-Apps:main Jul 8, 2024
8 checks passed
@ILIYANGERMANOV
Copy link
Collaborator

@CodinGeo do you want to have a stab and make the PR template more user friendly, as well? If so feel free to create an issue and I'll approve it

@CodinGeo CodinGeo deleted the fix-issue-3270 branch July 8, 2024 13:15
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
keep Keep it from automatically getting closed by Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix typos and mistakes in the Contributions Guidelines
2 participants