Skip to content

How to Contribute

There are two ways to contribute to the project:

  1. Create a Google Docs, and send them to Robinaites' on Twitter: Robinaite Twitter
  2. Use Gitlabs Merge Requests system to add new or updated content to the project for review

You can find a link to all the content being worked on or questions that still need answering on the Issues board: https://gitlab.com/Robinaite/crystal-library/-/boards

How do I use Gitlab merge request system?

To use Gitlab Merge Request system, you first need to Fork the project.

If you do not have the knowledge on how to use git, and do merge request I suggest you to use the second option and just report any issues or contribute to the project by sending over a google docs in Markdown format.

Become a verified contributor

A verified contributor is someone who has helped fix various issues or added consistent quality questions and answers to the project.

A verified contributor has:

  • Access to the project for direct editing of the files without needing to use forks. (making it thus easier)
Non-extensive information on how to use gitlab nonetheless

I want to fix an issue on a page or add more information to an existing page

Pre-requisites:

Follow the following steps:

  1. If you have done this before, check your own repository and make sure to delete it first, or look into mirroring.
  2. Go to the page with the issue.
  3. Click the edit button next to the title
  4. It will redirect you to gitlab
  5. Click on the edit button
    1. If its your first time editing the project, it will indicate "You can’t edit files directly in this project. Fork this project and submit a merge request with your changes." click Fork.
  6. Edit the texts with the issue. Please make sure you follow the guidelines found here: Guidelines
  7. When finished, scroll down and update the Commit Message with a small description of what you changed.
  8. Click Commit changes
  9. It will load the page to make a new Merge Request.
    1. Update title and description if you want (not necessary)
  10. Scroll down and click "Create Merge Request"
  11. Now you wait for someone with access to the repository to review your changes and merge (update) them in the project. This can take up to 24 hours.

If you are knowledgeable with git, feel free to use git to create a merge request, you do not need to follow the steps above.

I want to add a new question or page to the website

Pre-requisites:

Follow the following steps:

  1. If you have done this before, check your own repository and make sure to delete it first, or look into mirroring.
  2. Go to the gitlab repository found here: https://gitlab.com/Robinaite/ffxiv-faq
  3. Find the "Web IDE" button and click it.
    1. If its your first time contributing to the project, a message will pop-up saying "You can’t edit files directly in this project. Fork this project and submit a merge request with your changes." Click Fork Project.
  4. On the left you will see the folder structure, hover over the folder you want to add a new file to.
  5. Click the 3 dots and the arrow downwards to show a dropdown
  6. Click "New File".
    1. If you have a file you want to upload yourself, click upload file.
    2. If you want to add a new directory, click "New Directory"
  7. Make sure to follow the guidelines on adding new files! You can find the guidelines here: Guidelines
  8. When finished click Commit at the bottom.
  9. Write a commit message on what you added to the project.
  10. Select option "Create new branch"
  11. Have option "Start new merge request" enabled
  12. It will load the page to make a new Merge Request.
    1. Update title and description if you want (not necessary)
  13. Scroll down and click "Create Merge Request"
  14. Now you wait for someone with access to the repository to review your changes and merge (update) them in the project. This can take up to 24 hours.

If you are knowledgeable with git, feel free to use git to create a merge request, you do not need to follow the steps above.

Last update: July 11, 2021
Back to top