🤝 Contributing to The Midnight Brew

Thank you for considering contributing to our cozy digital café!

☕ Every contribution, no matter how small, helps us brew something special ✨

📋 Table of Contents

🌟 How Can I Contribute?
🐛 Reporting Bugs
💡 Suggesting Features
🔧 Development Setup
📝 Pull Request Process
💻 Coding Guidelines
🎨 Design Guidelines
✅ Commit Message Guidelines
📜 Code of Conduct

🌟 How Can I Contribute?

🐛

Report Bugs

Find and report issues to help us improve

Report Bug

💡

Suggest Ideas

Share your creative ideas for new features

Suggest Feature

🔧

Fix Issues

Pick an issue and submit a fix

View Issues

📝

Improve Docs

Help make our documentation better

Contribute

🎯 Contribution Areas

We welcome contributions in the following areas:

🐛 Bug Fixes - Help squash those pesky bugs
✨ New Features - Add exciting new functionality
🎨 UI/UX Improvements - Enhance the visual experience
📱 Responsive Design - Improve mobile experience
♿ Accessibility - Make our café accessible to everyone
🔒 Security - Strengthen our security measures
📝 Documentation - Improve guides and documentation
🌍 Translations - Help us reach a global audience
⚡ Performance - Optimize code and improve speed
🧪 Testing - Write tests to ensure quality

🐛 Reporting Bugs

Before creating a bug report, please check the existing issues to avoid duplicates.

📝 How to Submit a Good Bug Report

When filing a bug report, please include:

Clear Title - Be specific and descriptive
Description - Explain what happened vs. what you expected
Steps to Reproduce - Detailed steps to reproduce the issue
Screenshots - If applicable, add screenshots
Environment Details:
- OS (Windows, macOS, Linux)
- Browser (Chrome, Firefox, Safari, etc.)
- Browser Version
- Node.js Version (if backend issue)

🔖 Bug Report Template

## Bug Description
A clear description of what the bug is.

## Steps to Reproduce
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error

## Expected Behavior
What you expected to happen.

## Actual Behavior
What actually happened.

## Screenshots
If applicable, add screenshots.

## Environment
- OS: [e.g., Windows 11]
- Browser: [e.g., Chrome 120]
- Version: [e.g., 1.0.0]

## Additional Context
Any other relevant information.

💡 Suggesting Features

We love hearing your ideas! Before suggesting a feature:

Check existing issues to see if it's already been suggested
Search closed issues in case it was previously discussed
Consider if it fits the project's scope and vision

✨ Feature Request Template

## Feature Description
A clear description of the feature you'd like to see.

## Problem it Solves
Explain the problem this feature would solve.

## Proposed Solution
Describe how you envision this feature working.

## Alternative Solutions
Any alternative solutions you've considered.

## Additional Context
Screenshots, mockups, or examples from other projects.

## Benefits
- Benefit 1
- Benefit 2
- Benefit 3

🔧 Development Setup

Prerequisites

Before you begin, ensure you have the following installed:

Node.js (v16 or higher)
npm or yarn
MongoDB (v4.4 or higher)
Git

🚀 Getting Started

Fork the Repository

Click the "Fork" button at the top right of the repository page.

Clone Your Fork

git clone https://github.com/KrishnaSaxena108/The-Midnight-Brew.git
cd The-Midnight-Brew

Add Upstream Remote

git remote add upstream https://github.com/KrishnaSaxena108/The-Midnight-Brew.git

Install Dependencies
```
npm install
```

Set Up Environment Variables

cp .env.example .env
# Edit .env with your configuration

Start Development Server
```
npm run dev
```
Open in Browser

Navigate to http://localhost:3000

📝 Pull Request Process

✅ Before Submitting

Create a new branch for your feature/fix

git checkout -b feature/your-feature-name

Make your changes and commit them (see commit guidelines below)
Test thoroughly - Ensure your changes work as expected
Update documentation if needed
Keep commits clean - Squash unnecessary commits

🚀 Submitting Your PR

Push to your fork

git push origin feature/your-feature-name

Create Pull Request on GitHub
Fill out the PR template with all required information
Link related issues using keywords (Fixes #123, Closes #456)
Wait for review - Be patient and responsive to feedback

📋 Pull Request Template

## Description
Brief description of what this PR does.

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Related Issues
Fixes #(issue number)

## Changes Made
- Change 1
- Change 2
- Change 3

## Screenshots (if applicable)
Add screenshots here.

## Checklist
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code where necessary
- [ ] I have updated the documentation
- [ ] My changes generate no new warnings
- [ ] I have tested my changes thoroughly
- [ ] Any dependent changes have been merged

## Additional Notes
Any additional information reviewers should know.

⏱️ Review Process

PRs are typically reviewed within 2-5 business days
Maintainers may request changes or ask questions
Once approved, your PR will be merged
You'll be added to our contributors list! 🎉

💻 Coding Guidelines

🎨 Code Style

JavaScript

Use ES6+ syntax where appropriate
Use const and let instead of var
Use arrow functions for callbacks
Use template literals for string concatenation
Add semicolons at the end of statements
Use 2 spaces for indentation

// ✅ Good
const greeting = (name) => {
  return `Hello, ${name}!`;
};

// ❌ Bad
var greeting = function(name) {
  return 'Hello, ' + name + '!'
}

CSS

Use meaningful class names (BEM notation preferred)
Group related properties together
Use CSS variables for colors and common values
Add comments for complex sections
Keep selectors simple and avoid deep nesting

/* ✅ Good */
.menu-item {
  display: flex;
  align-items: center;
  padding: var(--spacing-md);
  background-color: var(--color-primary);
}

/* ❌ Bad */
.menu .item div {
  display: flex;
  align-items: center;
}

HTML

Use semantic HTML5 elements
Add alt text to images
Use proper heading hierarchy
Keep markup clean and readable
Add ARIA labels where appropriate

<!-- ✅ Good -->
<nav aria-label="Main navigation">
  <ul class="nav-list">
    <li class="nav-item">
      <a href="#home" class="nav-link">Home</a>
    </li>
  </ul>
</nav>

<!-- ❌ Bad -->
<div class="nav">
  <div>
    <a href="#home">Home</a>
  </div>
</div>

🔒 Security Best Practices

Never commit sensitive data (API keys, passwords)
Validate all user inputs
Sanitize data before database operations
Use environment variables for configuration
Follow OWASP security guidelines

⚡ Performance Guidelines

Optimize images before committing
Minimize HTTP requests
Use async/await for asynchronous operations
Avoid memory leaks
Cache when appropriate

🎨 Design Guidelines

🎨 Color Palette

Stick to our established color scheme:

Primary: #8B4513 (Saddle Brown)
Secondary: #D2691E (Chocolate)
Accent: #A0522D (Sienna)
Dark: #2C1810 (Dark Brown)
Light: #F5F5DC (Beige)

🖋️ Typography

Headings: Playfair Display
Body: System fonts / Sans-serif
Code: Monospace

📐 Spacing

Use consistent spacing throughout:

Small: 8px
Medium: 16px
Large: 24px
Extra Large: 32px

📱 Responsive Breakpoints

Mobile: < 768px
Tablet: 768px - 1024px
Desktop: > 1024px

✅ Commit Message Guidelines

Write clear, meaningful commit messages following this format:

📝 Format

<type>(<scope>): <subject>

<body>

<footer>

🏷️ Types

feat: New feature
fix: Bug fix
docs: Documentation changes
style: Code style changes (formatting, etc.)
refactor: Code refactoring
test: Adding or updating tests
chore: Maintenance tasks

✨ Examples

# Good commits
feat(menu): add coffee filter functionality
fix(auth): resolve JWT token expiration issue
docs(readme): update installation instructions
style(css): improve button hover effects

# Bad commits
fixed stuff
update
changes
asdfgh

📋 Commit Message Rules

Use present tense ("add" not "added")
Use imperative mood ("move" not "moves")
Keep subject line under 50 characters
Capitalize the subject line
Don't end with a period
Add detailed description in body if needed

📜 Code of Conduct

🤝 Our Pledge

We are committed to providing a welcoming and inclusive environment for everyone, regardless of:

Age
Body size
Disability
Ethnicity
Gender identity and expression
Level of experience
Nationality
Personal appearance
Race
Religion
Sexual identity and orientation

✨ Our Standards

Positive Behavior:

Using welcoming and inclusive language
Being respectful of differing viewpoints
Gracefully accepting constructive criticism
Focusing on what's best for the community
Showing empathy towards others

Unacceptable Behavior:

Trolling, insulting, or derogatory comments
Personal or political attacks
Public or private harassment
Publishing others' private information
Any conduct which could reasonably be considered inappropriate

🚨 Reporting Issues

If you experience or witness unacceptable behavior, please report it by contacting the project maintainer at the repository's issue tracker.

🎉 Recognition

🌟 Contributors

All contributors will be recognized in:

Our README.md contributors section
Release notes for their contributions
Special shoutouts in our community

🏆 Contribution Levels

☕ Coffee Enthusiast - 1-5 contributions
🌟 Regular Brewer - 6-15 contributions
🚀 Master Barista - 16+ contributions
💎 Core Team - Consistent, high-quality contributions

💬 Questions?

Need Help or Have Questions?

💬

GitHub Discussions

Ask a Question

📧

GitHub Issues

Open an Issue

🙏 Thank You!

☕ Your contributions make The Midnight Brew special ✨

We appreciate every contribution, big or small!

Happy coding and enjoy your virtual coffee! ☕🌙

⬆ Back to Top

FilesExpand file tree

CONTRIBUTING.md

Latest commit

History