gg-kit v1.0.0

Guardian Messages Icons

A TypeScript package for managing QA team messages and icons, specifically tailored for Slack notifications involving roles such as Green Guardian, Backup, and Temporary Backup. This package centralizes your message and icon management, ensuring consistency, scalability, and ease of maintenance across your projects.

📖 Table of Contents

1. Features
2. Installation
3. Usage
4. API Reference
5. Development
6. Testing
7. Contributing
8. License
9. Acknowledgements

✨ Features

• Centralized Management: Organize all your QA team messages and icons in one place.
• Type Safety: Leveraging TypeScript for robust type definitions.
• Random Selection: Functions to retrieve random messages and icons to keep notifications fresh.
• Easy Integration: Simple import statements to use in your projects.
• Scalable Structure: Easily add or modify messages and icons as your team evolves.
• Customizable: Tailor messages and icons to fit your team's culture and communication style.

🛠 Installation

Prerequisites

• Node.js (v14 or later)
• bun

Install via bun

bun install guardian-messages-icons

🚀 Usage

Integrate the package into your TypeScript project to manage and utilize your QA team messages and icons effectively.

import {
  GG_MESSAGES,
  BACKUP_MESSAGES,
  TEMP_BACKUP_MESSAGES,
  GG_ICONS,
  BACKUP_ICONS,
  TEMP_BACKUP_ICONS
} from 'guardian-messages-icons';

📚 API Reference

Messages

• GG_MESSAGES: string[] An array of messages designated for the Green Guardian role.
• BACKUP_MESSAGES: string[] An array of messages designated for the Backup role.
• TEMP_BACKUP_MESSAGES: string[] An array of messages designated for the Temporary Backup role. Icons
• GG_ICONS: string[] An array of emojis representing the Green Guardian role.
• BACKUP_ICONS: string[] An array of emojis representing the Backup role.
• TEMP_BACKUP_ICONS: string[] An array of emojis representing the Temporary Backup role.

🧑‍💻 Development

Cloning the Repository

git clone https://github.com/your-username/guardian-messages-icons.git
cd guardian-messages-icons

Installing Dependencies

bun install
# or
yarn install

Building the Project

Compile the TypeScript code into JavaScript.

bun run build
# or
yarn build

Testing

Run the test suite to ensure all functionalities work as expected.

bun run test
# or
yarn test

🧪 Testing

This package uses Jest for testing. The test suite ensures that all message and icon arrays contain the expected number of elements and function as intended.

Running Tests

bun run test
# or
yarn test

Sample Test Structure

• tests/messages.test.ts
  • Tests to verify the integrity of message arrays.
• tests/icons.test.ts
  • Tests to verify the integrity of icon arrays.

🤝 Contributing

Contributions are welcome! Whether it's reporting bugs, suggesting features, or submitting pull requests, your input is valuable to improve this package.

Steps to Contribute

1. Fork the Repository

Click the "Fork" button at the top-right corner of the repository page to create a copy under your GitHub account.

2. Clone the Forked Repository

git clone https://github.com/your-username/guardian-messages-icons.git
cd guardian-messages-icons

3. Create a New Branch

git checkout -b feature/your-feature-name

4. Make Your Changes

Implement your feature or fix in the appropriate files.

5. Commit Your Changes

git commit -m "Add feature: your feature description"

6. Push to Your Fork

git push origin feature/your-feature-name

7. Open a Pull Request

Navigate to the original repository on GitHub and click "Compare & pull request". Provide a clear description of your changes.

Guidelines

• Code Quality: Follow the existing code style and conventions.
• Descriptive Commit Messages: Write clear and concise commit messages.
• Testing: Ensure that new features or fixes include relevant tests.
• Documentation: Update the README.md or other documentation files as necessary.

📄 License

This project is licensed under the MIT License.

👏 Acknowledgements

• TypeScript
• Jest
• ESLint
• Prettier

📫 Contact

For any inquiries, issues, or feature requests, please open an issue on the GitHub repository or contact your-email@example.com.

Happy Coding! 🚀