[Feature Request]: Creation of dedicated Contributing.md file & License file along with Updation of README.md #269
Comments
|
I have noticed that you are assigning the wrong labels to the issues. I just wanted to inform you about that and here are the labels that must be assigned:
|
|
@mansiruhil13 The gssoc label must be gssoc-ext and not gssoc-extd. Please review this with the team and change it at your earliest since this is creating issues with many repositories. |
|
@mansiruhil13 Thanks for changing the label. |
|
Thank You! |
|
@mansiruhil13 while working, I also noticed that you don't have a license added to your project! Do you want me to add one? If yes, let me know. I will modify this issue and please do set the level to level3 if you want me to add one! |
okay |
|
I see that you are not much of a talk person and maybe shy.😆 |
rajdeepchakraborty-rc
changed the title
|
@mansiruhil13 I have updated the title and the description of the issue. You can go through it if you want. |
|
✅ This issue has been closed. Thank you for your contribution! If you have any further questions or issues, feel free to raise them, and we can discuss more! |
|
@mansiruhil13 why did you close this? I am still working on it and have not made a PR yet. |
|
Reopen the issue. I am still working on it, and will make a Pull Request(PR) when I am done and inform you. |
|
@mansiruhil13 Can you provide me with a picture of you? Since you don't have one on your GitHub profile. I want to make this in your README.md file: |
|
yes |
|
Ok will be using your LinkedIn Profile picture then. Thanks for replying 😀 |
|
@mansiruhil13 sorry, but can you update your GitHub profile picture to the one on your LinkedIn? Since you have edited out this image from the borders, it is not working good with the code. Can you change your GitHub profile picture to the one on your LinkedIn? |
update it |
|
Thanks it's done! |
|
for any queries.. line you can remove as in readme file, its' already mentioned |
|
I merged the Contact section with the new Team section that I made since there was just 1 line written: |
|
I have opened a Pull request #306. |
|
@mansiruhil13 Sorry but I could not understand what you said in the PR chat. Could you explain the issue? I saw you closed the PR without merging. What was the issue? |
|
Ok, I understood 1 of the issues. I overlooked changing your name under the LICENSE. That was my fault. I will change that. I think you were asking to put the name AmbuFlow in the LICENSE. Usually the owner's name is added there, but if you want me to add AmbuFlow there, I can do that. I am not sure what you said about the screenshots. Please explain that issue. |
|
✅ This issue has been closed. Thank you for your contribution! If you have any further questions or issues, feel free to raise them, and we can discuss more! |
Is there an existing issue for this?
Feature Description
1. Creation of Contributing.md file for Contributors.
Currently, there is no dedicated file for contributors, such as a Contributing.md. Instead, the documentation for both the project and contributors is combined within the README.md file, which demonstrates poor documentation practices.
I intend to create a separate Contributing.md file so that contributors can review the contribution procedure in detail. I also plan to support new contributors by including some git commands and outlining the structure they should follow to contribute effectively to the repository.
2. Updating the README.md file for better readability of the users.
Additionally, I want to update the existing README.md file to make it more interactive and engaging. I plan to create a separate file named Screenshots.md to store all the site’s screenshots, and then add a redirect link to this file from the README.md for users to refer to once they are finished reading the README.md file. I intend to remove the images from the README.md file, as they are causing excessive scrolling, which is becoming an issue. Creating a separate file and adding a redirect will improve the overall readability of the repository.
3. Creation of a License file
I will also make a License file [MIT license] for the project.
Use Case
1. Creation of Contributing.md file for Contributors.
The new Contributors will find it easy to navigate the required sections.
2. Updating the README.md file for better readability of the users.
The project will have an overall improved readability and scalability.
3. Creation of a License file
The License file is needed in projects that accepts contributions.
Benefits
1. Creation of Contributing.md file for Contributors.
This will assist new contributors by providing them with basic git commands and an outline of the structure they should follow to contribute effectively to the repository.
2. Updating the README.md file for better readability of the users.
I believe that keeping the README.md focused on the project description will enhance the overall quality of the documentation. Additionally, making the README.md more engaging and precise will help increase user interaction and activity.
3. Creation of a License file
I will help the Contributors know this is an Open-Source project and welcome all contributors to make updates.
Priority
High
Record
The text was updated successfully, but these errors were encountered: