Closed priyankarpal closed 1 year ago
Can I work on this?
Can I work on this?
Yeah sure. Assigned to you.
Cool on it
@priyankarpal Like this right?
@priyankarpal Like this right?
yeah.Looks Good 🎉 also share whole doc
@priyankarpal also the guide should just state how to copy and paste svgs , not what svgs are etc?
@priyankarpal also the guide should just state how to copy and paste svgs , not what svgs are etc?
yes. how to copy the code & paste.
Hey , I'm not getting the option for creating a PR?
Hey , I'm not getting the option for creating a PR?
why? are you in the code editor?
Hey , I'm not getting the option for creating a PR?
why? are you in the code editor?
I did the normal procedure , made a new branch , did my changes , commited and pushed to the new branch on my fork. But the change is not displaying for some reason
Hey , I'm not getting the option for creating a PR?
why? are you in the code editor?
I did the normal procedure , made a new branch , did my changes , commited and pushed to the new branch on my fork. But the change is not displaying for some reason
have you ever set upstream command?
yeah i set the upstream command as well
yeah i set the upstream command as well
could you share screenshots?
commit:
I think this is the issue. Im making the changes but they arent being commited because of lint error. Can you tell me how i should write the commit code. I am not familiar with husky
commit:
I think this is the issue. Im making the changes but they arent being commited because of lint error. Can you tell me how i should write the commit code. I am not familiar with husky
you need to add a proper title. such as "docs: added svg icon page"
commit:
I think this is the issue. Im making the changes but they arent being commited because of lint error. Can you tell me how i should write the commit code. I am not familiar with husky
you need to add a proper title. such as
"docs: added svg icon page"
still not working
@sboy99 please check
use docs:
instead of docs :
@ArslanYM if your problem is solved congrats otherwise, you can follow this document, which helped me: https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits.
@sboy99 @priyankarpal don't you think adding some examples in the "How to write professional commits ?" section, can give some extra clarity?
@sboy99 @priyankarpal don't you think adding some examples in the "How to write professional commits ?" section, can give some extra clarity?
Yes that is also a part of the documentation create a folder inside guides best practice
and we can write best practices as well
@sboy99 @priyankarpal don't you think adding some examples in the "How to write professional commits ?" section, can give some extra clarity?
Yes that is also a part of the documentation create a folder inside guides
best practice
and we can write best practices as well
Why create another folder when we can add them in the "How to write professional commits. mdx" file. Because if you check the "Here are some examples of good commit messages:" part those are actually the definitions of the terminology we use mostly like feat, fix, docs etc, but not the examples of commit messages. So if you create a part like "definitions of the terminologies" and then examples, don't you think that will be a good option?
Professional commits are useful to identify the type of work or change is being made. Additionally it supports automated releases. In software development most of the changes can be broken down into adding features
fixing bugs
doing a task
performance optimization
ci cd
etc. So to trigger this you can break your commit message into two.
sub: message
In the field of subject you can and conventions such as feat
fix
chore
refactor
etc. You can better check in the commitlint file. And followed by a suitable message. Thats it.
Di
@sboy99 @priyankarpal don't you think adding some examples in the "How to write professional commits ?" section, can give some extra clarity?
Yes that is also a part of the documentation create a folder inside guides
best practice
and we can write best practices as wellWhy create another folder when we can add them in the "How to write professional commits. mdx" file. Because if you check the "Here are some examples of good commit messages:" part those are actually the definitions of the terminology we use mostly like feat, fix, docs etc, but not the examples of commit messages. So if you create a part like "definitions of the terminologies" and then examples, don't you think that will be a good option?
Yup, we can do that as well
Di
@sboy99 @priyankarpal don't you think adding some examples in the "How to write professional commits ?" section, can give some extra clarity?
Yes that is also a part of the documentation create a folder inside guides
best practice
and we can write best practices as wellWhy create another folder when we can add them in the "How to write professional commits. mdx" file. Because if you check the "Here are some examples of good commit messages:" part those are actually the definitions of the terminology we use mostly like feat, fix, docs etc, but not the examples of commit messages. So if you create a part like "definitions of the terminologies" and then examples, don't you think that will be a good option?
Yup, we can do that as well
If you assign me I can do that.
If you assign me I can do It is assigned to you. Add a comment in #139
@ArslanYM are you working on this issue?
No im not
No im not
Hey if you don't want to work on this issue, @priyankarpal can I work on this one?
No im not
Hey if you don't want to work on this issue, @priyankarpal can I work on this one?
You can work on it 🤝 @suzy-g38
I want to add some images as a reference but the images are not loading properly. I followed the drag-and-drop method using Shift to add the image links....but it's not working somehow. I am sharing the screenshots:
And also I want to add that I have added the images in a folder 'how-to-add-svg-icon' inside the /images/getting-started.
use this trick & just paste the link.
use this trick & just paste the link.
Cool man loved it.
In the documentation, we need to add how a user can find the SVG icons code
Mention in the guide that we will use https://simpleicons.org website to find SVG icons code
You can use another website.
Folder Structure
In the red block area there will be a guide link where you need to mention how to copy & paste the SVG icons (for newbies)
Create a
.mdx file
into thedocs/guides/starting-contribution/
named ithow-to-add-SVG-icons.mdx
(exact same)Create a PR & wait for merge.