XplaiNLP Research Group

Our Webiste: XplaiNLP

Updating Information in This Repository

To ensure that all changes to the repository are made safely and collaboratively, please follow the steps below when updating any information.

This includes updating personal information, research content, or any webpage content on our website.

Steps to Update Information

1. Realize some information is incorrect or incomplete

   If it can be fixed quickly, such as a typo, spelling mistake or incorrect number. Please just use the EDIT mode on Github for quick fixes.

   However, if the amount of change will be heavy or complex. Please continue to follow the steps below.

2. Clone the Repository

   Clone the forked repository to your local machine.

    git clone https://github.com/XplaiNLP/xplainlp.github.io.git
    cd xplainlp.github.io
   

3. Create a New Branch

   Create a new branch for the changes you want to make. Please name the branch descriptively.

   For example, if you are updating your personal information, you might name the branch jiaao-info.

    git checkout -b jiaao-info
   

4. Make Changes

   Make the necessary changes to the files.

   For example, updating your profile in the xplainlp.github.io/content/authors/Jiaao Li/ directory.

   Most of content are stored in the xplainlp.github.io/content/ directory.

5. Commit Changes

   Commit the changes with a descriptive message.

    git add .
    git commit -m "Update personal information for Jiaao Li"
   

6. Push Changes

   Push the changes to your new branch.

    git push origin jiaao-info
   

7. Create a Pull Request

   Go to the original repository on GitHub and create a pull request from your branch with a clear description of the changes.

8. Review and Merge

   Other staff members can review the pull request.

   Once approved, it can be merged into the main branch.

Contact

If you have any questions or need further assistance, please feel free to contact Jiaao Li on our Discord channel.

Further Information

Hugoblox Documentation

Hugoblox|Docs

Hugo Site Customization

Example Branch Names

• Updating personal information: jiaao-info
• Adding a new research publication: new-publication
• Updating webpage information: update-contact

Important Notes

• Please always create a new branch for your changes to avoid conflicts and ensure stability of our website.
• Provide clear and descriptive commit messages and pull request descriptions.
• Please ensure your changes align with HugoBlox Syntax.

Thank you for your cooperation!