Skip to content

collegekatta/greetings.collegekatta.in

Repository files navigation

Features

Our project is currently focused on the frontend and does not involve the creation of a database for data storage. However, we have plans to expand the feature set in the future, which includes:

  • A user-friendly form for adding and managing details.
  • The ability to generate and share personalized wishes simply by opening a URL.

We are dedicated to continuously enhancing the project with exciting features in the future. Since this is an open-source project, we encourage both contributions and suggestions from the community to help shape its development. Your ideas and input are highly valued as we strive to make this project even better.


Thank you for your interest in contributing to our project! We appreciate your help in making it better.

To get started, please follow the guidelines below:

How to Contribute

  1. Fork this repository to your own GitHub account.

  2. Clone the forked repository to your local machine.

  3. Create a new branch for your feature or bug fix. : git checkout -b feature/your-feature

  4. Make your changes, and commit them with a clear and concise message. : git commit -m "Add your commit message here"

  5. Push your changes to your GitHub repository. : git push origin feature/your-feature

  6. Create a Pull Request (PR) from your forked repository to our main repository. Ensure your PR includes a clear description of your changes and, if applicable, references any related issues.

  7. Your PR will be reviewed, and you may need to make additional changes. Please be responsive to feedback and make the necessary adjustments.

  8. Once your PR is approved and passes any required tests, it will be merged into the main project.

Here's a guide on how you can effectively contribute:

  1. Pull Requests for Readme Updates: Please refrain from sending pull requests solely for updating the project's readme file. While we appreciate the importance of clear and concise documentation, we prefer to focus on substantial code contributions and feature enhancements.

  2. Grammar Updates: Our team values effective communication, but we're not grammar sticklers. You don't need to send pull requests solely for grammar fixes or minor language improvements. Instead, concentrate on the core functionalities and features of the project.

Starting with the Basics

  1. Begin by setting up a virtual host to dive into your project and explore its potential.

  2. To introduce a new theme or template, simply navigate to the ./templates folder and unleash your creativity.

  3. For adding a fresh celebratory theme or special occasion:

    1. Start by heading to the ./js/data/ directory.
    2. In the types.js file, append your new celebration type to the 'types' array.
    3. Next, craft an array of delightful quotes in the quotes.js file.
    4. Then, proceed to the ./templates folder and create a new file with the same name as the type you added in the 'types' array in types.js.
    5. Construct and customize the theme to your liking, managing it as you see fit.

Code of Conduct

Issues

If you find any issues or have feature requests, please feel free to open an issue on our Issue Tracker.


We appreciate your support in improving wishes.collegekatta.in! If you have any questions or need further assistance, please don't hesitate to ask.