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

Establish the Update Log for Oneseco Media's 2.0 version of the Readme #49

Open
4 tasks
Cybersoulja opened this issue Feb 18, 2024 · 0 comments
Open
4 tasks
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Cybersoulja
Copy link
Member

Objective

To maintain a transparent and detailed history of changes made to the Oneseco Media README file, we propose the creation of an update log. This log will serve as a chronological record of amendments, additions, and significant updates, enhancing our documentation's clarity and usefulness for all stakeholders.

Rationale

  • Transparency: Provides clear visibility into the document's evolution, offering insights into why changes were made.
  • Accountability: Tracks contributions to the README, highlighting the efforts of our community and team members.
  • Ease of Use: Helps users and contributors quickly identify recent changes and understand the project's development over time.

Proposed Implementation

  • Update Log Location: The log will be included at the bottom of the README file, ensuring easy access.
  • Format: Each entry will include the date of the update, a brief description of the change, and the GitHub username of the contributor responsible for the update.
  • Process: Contributors who make significant changes to the README must add an entry to the update log as part of their pull request.

Tasks

Preview Give feedback
@Cybersoulja Cybersoulja added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 18, 2024
@Cybersoulja Cybersoulja moved this from Backlog to In progress in @Cybersoulja's Readme/Wiki Project Feb 18, 2024
@Cybersoulja Cybersoulja self-assigned this Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: In progress
Development

No branches or pull requests

1 participant