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

feat:add contributing file remove unused log #21

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Contributing Guidelines

Thank you for considering contributing to the mostaqem-api project! We appreciate your interest and support. Before you get started, please take a moment to review the following guidelines.

## Reporting Issues & Bugs

- **Check Existing Issues**: Before opening a new issue, please make sure to check if the issue has already been reported.
- **Provide Details**: When reporting an issue, please include as much information as possible. This includes steps to reproduce, environment details, and expected vs. actual behavior.
- **Bug Labels**: To help categorize your issue, please add relevant labels such as `bug` or `enhancement`.

## Requesting Features

- **Feature Requests**: If you have a feature request, please use the provided `feature request` template and clearly describe the desired functionality.
- **Be Specific**: When requesting a feature, provide context on why it is valuable and how it could be implemented.

## Coding Standards

When contributing to the mostaqem-api project, we follow the coding standards and best practices for the NestJS framework. Additionally, we adhere to the SOLID principles. Here are some guidelines to keep in mind:

### NestJS Framework

- **Module Structure**: Organize your code into modules, each with a clear responsibility and purpose.
- **Dependency Injection**: Utilize NestJS's built-in dependency injection system to manage dependencies between classes.
- **Controllers**: Keep controllers focused on handling HTTP requests and delegate business logic to services.
- **Services**: Encapsulate business logic in services, keeping them reusable and testable.
- **Providers**: Use providers to manage shared resources, such as database connections or external APIs.
- **Middleware**: Implement middleware to handle cross-cutting concerns, such as authentication or logging.
- **Error Handling**: Properly handle errors by using NestJS's exception filters and providing meaningful error messages.

By following these coding standards and principles, we can ensure a clean, maintainable, and scalable codebase for the mostaqem project.

## Submitting Pull Requests

- **Branching**: Create a feature branch for your work.
- **Commits**: Write clear and concise commit messages.
- **Pull Request Description**: Describe the purpose of the pull request and link any relevant issues.

## Communication

- **Collaborate**: Engage in constructive discussions and provide feedback during code reviews.
- **Be Respectful**: Treat all contributors and their work with respect.

May you enter Heaven.
(يارب تخش الجنه ) 🤲🫶
1 change: 0 additions & 1 deletion src/audio/audio.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ export class AudioService {
): Promise<TilawaSurah & { reciter_id: number }> {
const { surah_id, reciter_id } = paginatedFilter;
let tilawa_id = paginatedFilter.tilawa_id;
console.log(tilawa_id);

if (!reciter_id && !tilawa_id)
throw new ConflictException('Reciter or Tilawa are required');
Expand Down
Loading