search

BirnadinErick / spc-175

St. Patrick's College official website repo for 175th.
https://www.spcjaffna-beta.org
Apache License 2.0
2 stars 4 forks source link

Onboard new-comer #19

Closed BirnadinErick closed 1 year ago

BirnadinErick commented 1 year ago

Description

Welcome to our project! As we embark on the journey to achieve Milestones, it's essential to provide a smooth onboarding experience for newcomers who wish to contribute to our repository. This issue is dedicated to outlining the project's features and providing guidance for new contributors.

Project Features

  1. Basic Blogging Feature (v1.0.0): The project's foundation revolves around a user-friendly, frontend-based blogging platform. Newcomers will have the opportunity to get involved in building and enhancing the blogging interface, including post creation, editing, and viewing.

  2. User Authentication, Comments, Likes (v2.0.0): With the introduction of user authentication, the project becomes more interactive. Contributors can help implement user registration, login functionality, and the management of user profiles. Additionally, new contributors can work on features like comments, likes, and notification systems to foster user engagement.

  3. Donation Tracking and Alumni Chat System (v3.0.0): In the upcoming milestone, our project will expand its capabilities with the introduction of a donation tracking system and an alumni chat system. Newcomers will have the opportunity to contribute to these significant features, allowing for the recording and management of donations and the creation of a chat platform exclusively for alumni members.

Onboarding Guidance

To get started with contributing to our project, please follow these steps:

  1. Familiarize Yourself with the Project: Read through the project's README, documentation, and existing code to gain a good understanding of our goals and existing work.

  2. Select a Milestone Feature: Choose one of the features from Milestone that aligns with your interests and expertise.

  3. Setup Development Environment: Follow the setup instructions in our documentation to configure your development environment.

  4. Create a Branch: Create a new branch for your work, named after the feature you're working on.

  5. Start Contributing: Dive into the code, work on your feature, and make your changes. Follow our coding style guidelines and make sure your code is well-documented.

  6. Testing and Quality Assurance: Test your changes thoroughly and ensure they don't introduce any new bugs. Consider writing tests if applicable.

  7. Submit a Pull Request: Once you're satisfied with your work, submit a pull request (PR) to the main repository. Be sure to describe your changes, reference this onboarding issue, and tag relevant maintainers for review.

  8. Collaboration and Feedback: Be open to feedback and collaboration. Our community is here to support you and help you grow as a contributor.

We're excited to have you on board and look forward to your contributions to our project. If you have any questions or need assistance, don't hesitate to reach out in the project's communication channels. Welcome to our team!

BirnadinErick commented 1 year ago

@Tharshan-dilky welcome to the project, hope u have a blast :)