Skip to content

Latest commit

 

History

History
117 lines (84 loc) · 4.31 KB

CONTRIBUTION.md

File metadata and controls

117 lines (84 loc) · 4.31 KB
Raw

Contributing to Ice-Cream-Parlour-Website

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.

How Can I Contribute?

Reporting Bugs

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.

Suggesting Enhancements

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.

Pull Requests

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!

Coding Standards

Please follow these coding standards:

  • Follow the existing code style.
  • Write clear, concise, and descriptive commit messages.
  • Keep your changes focused and avoid unrelated changes.
  • Write tests for any new functionality.
  • Make sure all tests pass before submitting your pull request.

Getting Started

  1. Fork the Repository Go to the repository page. Click the Fork button (top right) to create a copy of the project in your GitHub account.

  2. Clone Your Fork Clone the repository to your local machine using the command:

git clone https://github.com/your-username/ice-cream-parlour-website.git

Replace your-username with your GitHub username.

  1. Create a New Branch Before making any changes, create a new branch for your work:
git checkout -b your-branch-name

Use a descriptive branch name indicating the feature or fix, such as fix-navbar or add-contact-form.

  1. Make Your Changes Open the project files in your code editor (like VS Code) and make your changes. You can contact the project manager Dharshi Balsubramaniyam for any queries you have.

  2. Test Your Changes Make sure your changes work correctly by testing the website locally. Open the index.html file in your browser to see your updates.

  3. Commit Your Changes Once your changes are ready, commit them with a descriptive message:

git add .
git commit -m "Added feature X or Fixed issue Y"
  1. Push Your Changes Push your changes to your forked repository on GitHub:
git push origin your-branch-name
  1. Create a Pull Request (PR) Go back to the original repository here.

Click the Compare & pull request button. Write a short description of your changes and submit the pull request (PR).

  1. Review Changes The project manager will review your PR. If approved, your changes will be merged.

Issue and PR Rules

When creating issues and pull requests, please follow these rules:

  1. Descriptive Titles: Use clear and concise titles that summarize the changes or problems.
  2. Detailed Descriptions: Provide detailed descriptions outlining what the issue is, how to reproduce it, or what changes the PR introduces.
  3. Link Related Issues: Mention the issue number (e.g., “Fixes #12”) to automatically link it.
  4. Respect Contribution Points: Ensure the complexity of your changes aligns with the assigned contribution level.
  5. Test Your Changes: Always test your changes thoroughly before submitting a PR.
  6. Follow Code Style Guidelines: Maintain consistency in code formatting and style.
  7. Avoid Duplicate Issues: Check if a similar issue already exists to avoid duplication.
  8. Be Respectful and Professional: Maintain a respectful tone in discussions and feedback.

Community

Feel free to join our community discussions in the Issues and Pull Requests sections of the repository.

Thank you for your contribution!