From e359a9cb06e8f32e71d9b3dc141a7c7e16a5b0a4 Mon Sep 17 00:00:00 2001 From: Nucleo Fusion <148791547+NucleoFusion@users.noreply.github.com> Date: Mon, 21 Apr 2025 15:34:49 +0530 Subject: [PATCH] Update README.md --- README.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 84 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b45c2f0..e411919 100644 --- a/README.md +++ b/README.md @@ -1 +1,84 @@ -# katalogue \ No newline at end of file +# Katalogue + + +## 🤖 **About** +Katalogue is a social platform where users can log, rate, and categorize the games, movies, and shows they've experienced. Instead of generic ratings, users create custom categories to build personalized leaderboards. Friends can follow each other’s updates, explore memory galleries, and join public discussions. With its unique features Katalgue aims to turn your media journey into a shared, living archive. + +--- + +## 🛠️ Setup and Installation + +Follow these steps to set up the GlaDOS Community Bot on your local machine or server: + +### Prerequisites +- **Node.js**: Ensure you have Node.js installed (version specified in `.nvmrc` or `package.json`). +- **Git**: Install Git to clone the repository. + + +### Installation Steps +1. **Fork the Repository**: Fork this repo to your personal Github account +2. **Clone the Repository**: + ```bash + git clone git@github.com:your-username/katalogue.git + cd katalogue +3. **Install Dependencies**: + ```bash + cd katalogue-frontend && npm install + +## 🚀 How to Contribute + +We love contributions from everyone! Whether you're fixing a bug, adding a new feature, or improving documentation, your help is always appreciated. Here's how you can contribute: + +Follow the steps below to contribute effectively: + +1. **Fork the Repository:** Start by forking the repository to your own GitHub account. + +2. **Clone the Repository:** Clone the forked repository to your local development environment.

+`git clone https://github.com/your-username/d2d.git` + +3. **Create a New Branch Locally:** Create a branch for your feature or fix. Name your branch in a way that describes the purpose of your changes. For example: +- `feature/feature-name` +- `bugfix/bug-description` +- `docs/clarify-setup-instructions` + +4. **Make Your Changes:** + - Add your code, features, or bug fixes. + +5. **Commit Guidelines:** When committing changes to your branch, please follow this naming scheme to keep commit history clean and readable: + +Commit message format: `:` + +Types: + + feat: A new feature or functionality added to the project. + fix: A bug fix. + docs: Documentation changes. + style: Code style changes (e.g., formatting, missing semicolons). + refactor: Code changes that neither fix a bug nor add a feature, but improve the structure. + test: Adding or modifying tests. + chore: Changes to the build process or auxiliary tools. + +Example Commit Messages: + + feat: add user authentication to the website + fix: resolve issue with missing image on homepage + docs: update README.md with contribution guidelines + style: format code according to ESLint rules + test: add unit test for login function + chore: update dependencies to latest version + +6. **Push and Create a Pull Request:** Once you're ready, push your changes to your forked repository and open a pull request to the `dev` repository.\ + **Note:** open a pull request per feature and don't forget to link the corresponding issue by writing the `#issue-number`. + +7. **Follow Up** We will review your changes and may provide feedback. Please address any comments or requested changes, and we’ll merge your contribution! + +--- + +## 💡 Contribution Tips + +- Always follow the coding style and best practices. +- Keep PRs concise and focused on a single feature or fix. +- Stay engaged in the discussions and suggest improvements. + +---