Skip to content

Important: Clean Up Documentation & Add Standard Markdown Files #192

Description

@Renu-code123

Description

Some contributors added multiple unnecessary .md files through extra PRs, which can cause confusion for new contributors.

I have already removed the unnecessary markdown files to maintain clarity and a standard documentation structure.
Going forward, we want to keep only essential documentation files.


✅ Your Task

Please add or update content only in the following standard markdown files:

  • README. md – Project overview, setup instructions, and usage
  • CONTRIBUTING. md – Contribution guidelines and workflow
  • DATABASE.md – Database schema, structure, and setup details
  • BACKEND.md – Backend architecture, APIs, and server setup
  • CODE_OF_CONDUCT.md – Community rules and expected behavior

📌 Make sure these files are:

  • Well-structured
  • Easy to understand
  • Properly formatted using Markdown

❌ Important Note

  • I have already removed all unnecessary .md files, so please do not add new or extra markdown files.
  • Any extra or unnecessary .md files will be removed to avoid confusion.
  • Stick strictly to the files mentioned above for any documentation updates.
  • For any new features or changes, update documentation only within the listed files.
  • Do not create random, duplicate, or unofficial .md files.

🎯 Goal

To keep the repository clean, beginner-friendly, and well-documented for future contributors.

If you have any doubts, feel free to ask in the comments before starting work.
Happy contributing! 🚀✨

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    AnnouncementThese instructions must be followed properlyECWoC26

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions