Skip to content

♻️ Refactor documentation of the project#58

Merged
sthiepaan merged 12 commits into
bhatvikrant:masterfrom
sthiepaan:10-refactor-documentation
Oct 28, 2020
Merged

♻️ Refactor documentation of the project#58
sthiepaan merged 12 commits into
bhatvikrant:masterfrom
sthiepaan:10-refactor-documentation

Conversation

@sthiepaan
Copy link
Copy Markdown
Collaborator

@sthiepaan sthiepaan commented Oct 17, 2020

General

Reference: #10
Description:
This Pull Request is about refactoring whole documentation of the project including:

  • Refactor README.md file
  • Prepare CHANGELOG.md file
  • Prepare CONTRIBUTING.md file
  • Prepare other GitHub template file(s)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Additional notes

@sthiepaan sthiepaan requested a review from bhatvikrant October 17, 2020 20:49
@sthiepaan sthiepaan self-assigned this Oct 17, 2020
Damian Szczypka added 8 commits October 18, 2020 10:03
- Add URLs to badges
- Change sections order
- Refactor 'How to use' Section
- Refactor 'Available methods' Section
- Refactor 'Core team' Section
- Add reminder to run tests in 'CONTRIBUTING.md'
- Fix typo in 'README.md'
- Add URL to pull request
- Add URL to profile on GitHub of pull request author
@sthiepaan sthiepaan linked an issue Oct 18, 2020 that may be closed by this pull request
Comment thread README.md Outdated
@sthiepaan sthiepaan merged commit e5cab43 into bhatvikrant:master Oct 28, 2020
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.

Enhance the README.md file i.e. the documentation

2 participants