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

Changed the Readme.md to include the article and added Contributors.txt #318

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Aarav-g123
Copy link

These changes add the article to the readme.md

I added an article to the readme.md to make this project seem more interesting

They can clearly understand what the project is actually about

Checklist

  • [.] I think the code is well written
  • [.] Unit tests for the changes exist
  • [.] Documentation reflects the changes
  • [.] Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> (e.g. 588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the PR
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: Fix issue with non-ascii contents in doctest text files.

@Arfey
Copy link
Member

Arfey commented Aug 18, 2023

hi. thx for your contribution

I'm not sure that readme it's a good place for articles section. what do u think if u publish this article on the medium.com or dev.to and we just add reference to the readme?

@Aarav-g123
Copy link
Author

Absolutely, I agree that it's better to put it on medium.com. I read the brief and presumed it was meant to be in the readme but creating a whole separate place to put everything seems much better

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