First off, Thank you for considering contributing to our project! Your time and effort are greatly appreciated.
The following is a set of guidelines for contributing to Ice-Cream-Parlour-Website. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This section guides you on how to report bugs.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include:
- A descriptive title and a summary.
- Steps to reproduce the bug.
- The version of Ice-Cream-Parlour-Website you are using.
- Any other details that you think are relevant.
This section guides you on how to suggest enhancements.
- Search GitHub issues to ensure the feature hasn't been requested.
- If it hasn't been requested, open an issue and describe:
- The enhancement you would like to see.
- Why you think it would be useful.
- Any additional context or ideas.
This section guides you on how to submit pull requests.
- Fork the repository and create your branch from
main. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
If you're new to Git and GitHub, no worries! Here are some useful resources:
- Forking a Repository
- Cloning a Repository
- How to Create a Pull Request
- Getting Started with Git and GitHub
- Learn GitHub from Scratch
ICE-CREAM-PARLOUR-WEB/
├── .github/ # GitHub-related configurations, workflows, etc.
│
├── images/ # Images for the ice-cream parlour website
│
├── script/ # JavaScript files for interactivity
│
├── styles/ # CSS files for styling the website
│
├── blogs.html # Blog page
├── catering.html # Catering services page
├── CONTRIBUTION.md # Contribution guidelines for the project
├── contributor.html # Contributor section of the website
├── delivery.html # Delivery services page
├── dine-in.html # Dine-in services page
├── faq.html # Frequently asked questions page
├── gallary.html # Image gallery (rename to gallery.html for correctness)
├── index.html # Homepage of the website
├── login.html # Login page for users
├── privacy.html # Privacy policy page
├── products.html # Products list page (ice-cream items)
├── README.md # Project overview and instructions
├── signup.html # Signup page for new users-
Star this repository Click on the top right corner marked as Stars at last.
-
Fork this repository Click on the top right corner marked as Fork at second last.
-
Clone the forked repository
git clone https://github.com/<your-github-username>/ice-cream-parlour-website.git- Navigate to the project directory
cd ice-cream-parlour-website- Create a new branch
git checkout -b <your_branch_name>- To make changes
git add .- Now to commit
git commit -m "add comment according to your changes or addition of features inside this"- Push your local commits to the remote repository
git push -u origin <your_branch_name>-
Create a Pull Request
-
Congratulations! 🎉 you've made your contribution
-
Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.
-
Clone the Repository:
- If you haven't cloned the Project-Guidance repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
- Choose the Project-Guidance repository from the list of repositories on GitHub and clone it to your local machine.
3.Switch to the Correct Branch:
- Ensure you are on the branch that you want to submit a pull request for.
- If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.
- Make Changes:
- Make your changes to the code or files in the repository using your preferred code editor.
- Commit Changes:
- In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
- Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.
- Push Changes to GitHub:
- After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
- Create a Pull Request:
- Go to the GitHub website and navigate to your fork of the Project-Guidance repository.
- You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
- Review and Submit:
- On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
- Once you're satisfied, click the "Create pull request" button to submit your pull request.
- Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the Project-Guidance repository.
- Admin :- Dharshi Balasubramaniyam
- Contact :- Email
-
Follow the Project's Code Style
- Maintain consistency with the existing code style (indentation, spacing, comments).
- Use meaningful and descriptive names for variables, functions, and classes.
- Keep functions short and focused on a single task.
- Avoid hardcoding values; instead, use constants or configuration files when possible.
-
Write Clear and Concise Comments
- Use comments to explain why you did something, not just what you did.
- Avoid unnecessary comments that state the obvious.
- Document complex logic and functions with brief explanations to help others understand your thought -process.
-
Keep Code DRY (Don't Repeat Yourself)
- Avoid duplicating code. Reuse functions, methods, and components whenever possible.
- If you find yourself copying and pasting code, consider creating a new function or component.
-
Write Tests
- Write unit tests for your functions and components.
- Ensure your tests cover both expected outcomes and edge cases.
- Run tests locally before making a pull request to make sure your changes don’t introduce new bugs.
-
Code Reviews and Feedback
- Be open to receiving constructive feedback from other contributors.
- Conduct code reviews for others and provide meaningful suggestions to improve the code.
- Always refactor your code based on feedback to meet the project's standards.
When creating issues and pull requests, please follow these rules:
- Descriptive Titles: Use clear and concise titles that summarize the changes or problems.
- Detailed Descriptions: Provide detailed descriptions outlining what the issue is, how to reproduce it, or what changes the PR introduces.
- Link Related Issues: Mention the issue number (e.g., “Fixes #12”) to automatically link it.
- Respect Contribution Points: Ensure the complexity of your changes aligns with the assigned contribution level.
- Test Your Changes: Always test your changes thoroughly before submitting a PR.
- Follow Code Style Guidelines: Maintain consistency in code formatting and style.
- Avoid Duplicate Issues: Check if a similar issue already exists to avoid duplication.
- Be Respectful and Professional: Maintain a respectful tone in discussions and feedback.
Feel free to join our community discussions in the Issues and Pull Requests sections of the repository.
We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀