Skip to content

2 Instructions for Local Setup and Contribution

Kent Hinaloc edited this page Dec 16, 2022 · 3 revisions

Instructions for local setup

  1. First, make sure you have the necessary tools installed on your local machine, including a text editor and a local server environment such as XAMPP or MAMP.
  2. Next, clone the repository to your local machine using the following command: git clone https://github.com/[USERNAME]/[REPOSITORY].git
  3. Navigate to the directory where the repository has been cloned and start your local server environment.
  4. Open the index.html file in your text editor and make any desired changes.
  5. Save your changes and view them by refreshing the webpage in your web browser.

Instructions for contribution

  1. If you wish to contribute to the project, first create a fork of the repository using the "Fork" button on the GitHub page.
  2. Clone your fork of the repository to your local machine using the following command: git clone https://github.com/[USERNAME]/[REPOSITORY].git
  3. Create a new branch for your changes using the following command: git branch [BRANCHNAME]
  4. Switch to your new branch using the following command: git checkout [BRANCHNAME]
  5. Make your desired changes and commit them to your branch using the following commands: git add . git commit -m "[COMMIT MESSAGE]"
  6. Push your changes to your fork of the repository using the following command: git push origin [BRANCHNAME]
  7. From your fork of the repository, create a pull request using the "New pull request" button on the GitHub page.

Guidelines for submitting issues and pull requests

  1. When submitting an issue, be sure to provide a clear and descriptive title as well as a detailed description of the problem you are experiencing.
  2. When submitting a pull request, be sure to include a clear and concise description of the changes you have made and why they are necessary.
  3. Make sure your code follows the project's coding style and guidelines.
  4. Test your code thoroughly before submitting to ensure it is functional and does not introduce any new issues.