-
Notifications
You must be signed in to change notification settings - Fork 175
commit #529
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
Open
JustinBenito
wants to merge
1
commit into
main
Choose a base branch
from
JustinBenito-patch-5
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
commit #529
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,144 +1 @@ | ||
| # Contributing to TamilNadu.tech Communities | ||
|
|
||
| Thank you for your interest in contributing to TamilNadu.tech Communities! We aim to make contributing as easy and transparent as possible. Whether you're adding your community's events, fixing bugs, or improving documentation - every contribution matters! | ||
|
|
||
| ## 🎯 Quick Start | ||
|
|
||
| 1. Fork the repository | ||
| 2. Clone your fork: | ||
| ```bash | ||
| git clone https://github.com/your-username/Communities.git | ||
| cd Communities | ||
| ``` | ||
| 3. Create a new branch: | ||
| ```bash | ||
| git checkout -b feature/your-feature-name | ||
| ``` | ||
|
|
||
| ## 💻 Adding Events (Most Common Contribution) | ||
|
|
||
| Adding your community events is the most common and easiest way to contribute! Here's a detailed guide: | ||
|
|
||
| ### Step 1: Locate the Events File | ||
|
|
||
| Navigate to `src/data/events.json` in your forked repository. | ||
|
|
||
| ### Step 2: Add Your Event | ||
|
|
||
| Add your event to the JSON array using this template: | ||
|
|
||
| ```json | ||
| { | ||
| "eventName": "Your Event Name", | ||
| "eventDescription": "Brief description of the event (max 200 characters)", | ||
| "eventDate": "2024-02-20", | ||
| "eventTime": "14:30", | ||
| "eventVenue": "Full venue address", | ||
| "eventLink": "https://registration-link.com", | ||
| "location": "City Name", | ||
| "communityName": "Your Community Name", | ||
| "communityLogo": "https://url-to-your-logo.svg" | ||
| } | ||
| ``` | ||
|
|
||
| **Field Requirements:** | ||
|
|
||
| - `eventDate`: YYYY-MM-DD format | ||
| - `eventTime`: 24-hour format HH:MM | ||
| - `communityLogo`: Use imgbb to host images or add hostname to `next.config.ts` | ||
|
|
||
| ### Step 3: Validate Your Event Entry | ||
|
|
||
| Ensure: | ||
|
|
||
| - All dates are in the future | ||
| - All fields are filled out correctly | ||
| - The event is taking place in Tamil Nadu | ||
| - URLs are valid and accessible | ||
| - Your community logo is a high-quality image (preferably SVG) | ||
|
|
||
| ### Step 4: Submit Your Changes | ||
|
|
||
| 1. Commit your changes using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/): | ||
|
|
||
| ```bash | ||
| git add src/data/events.json | ||
| git commit -m "feat: add [Your Event Name] on [Date]" | ||
| git push origin feature/your-feature-name | ||
| ``` | ||
|
|
||
| **Commit Message Guidelines:** | ||
|
|
||
| - **feat:** New feature (e.g., `feat: add React Chennai meetup on Dec 15`) | ||
| - **fix:** Bug fix (e.g., `fix: correct event date format`) | ||
| - **docs:** Documentation (e.g., `docs: update setup instructions`) | ||
| - **refactor:** Code restructuring | ||
| - **test:** Tests | ||
| - **chore:** Maintenance (e.g., `chore: update dependencies`) | ||
|
|
||
| 2. Create a Pull Request with: | ||
| - **Title:** Follow the conventional commit format (e.g., `feat: add [Your Event Name]`) | ||
| - **Description:** Brief details about the event and why it was added | ||
|
|
||
| ## 🐛 Reporting Bugs | ||
|
|
||
| 1. Check existing issues first | ||
| 2. Create a new issue with: | ||
| - Clear title | ||
| - Steps to reproduce | ||
| - Expected vs actual behavior | ||
| - Screenshots (if applicable) | ||
|
|
||
| ## 💡 Feature Requests | ||
|
|
||
| Have ideas to make the platform better? Create an issue with: | ||
|
|
||
| - Clear title | ||
| - Detailed description | ||
| - Use cases | ||
| - Potential implementation details | ||
|
|
||
| ## 💻 Development Setup | ||
|
|
||
| ### Environment Variables | ||
|
|
||
| 1. Copy `.env.example` to `.env`: | ||
|
|
||
| ```bash | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| 2. **(Optional)** Generate VAPID keys for push notifications: | ||
|
|
||
| > **Note:** Push notifications are disabled in non-production environments. VAPID keys are only required when `NODE_ENV=production`. | ||
|
|
||
| ```bash | ||
| npx web-push generate-vapid-keys | ||
| ``` | ||
|
|
||
| 3. Update `.env` with: | ||
| - `NEXT_PUBLIC_VAPID_PUBLIC_KEY` - (Optional) Public VAPID key | ||
| - `VAPID_PUBLIC_KEY` - (Optional) Server-side public key | ||
| - `VAPID_PRIVATE_KEY` - (Optional) Server-side private key | ||
| - `GITHUB_TOKEN` - (Optional) For subscription management | ||
| - `UMAMI_ANALYTICS_ID` - (Optional) Analytics | ||
|
|
||
| ### Development Guidelines | ||
|
|
||
| - Use TypeScript for all code | ||
| - Follow existing code style | ||
| - Use conventional commits | ||
| - Add comments for complex logic | ||
| - Update docs when needed | ||
| - Test locally before PR | ||
|
|
||
| ## 🤝 Community Guidelines | ||
|
|
||
| - Be kind and respectful | ||
| - Help others | ||
| - Share knowledge | ||
| - Participate in discussions | ||
|
|
||
| ## 📝 License | ||
|
|
||
| By contributing, you agree that your contributions will be licensed under the GPL 3.0 License. | ||
| commit now. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Critical: Restore the original CONTRIBUTING.md content.
This change replaces 144 lines of comprehensive contribution guidelines with a single meaningless line. The CONTRIBUTING.md file is essential documentation that helps new contributors understand how to participate in the project. Removing it blocks contributor onboarding and eliminates all documented workflows and best practices.
This appears to be an accidental commit or test change that should not be merged.
Recommended action: Revert this PR and restore the original CONTRIBUTING.md content. If updates to the contribution guidelines are needed, they should be made incrementally while preserving the existing structure and valuable content.
🤖 Prompt for AI Agents