-
Notifications
You must be signed in to change notification settings - Fork 13
How to: Participate in writing the IT‐recommondations
If you do not yet have a Github account, you should create one. The repository can then be made into an independent project based on an existing project. This is called a "fork" (for the meaning see: here ) In preparation, the entire content of https://github.com/dainst/ianus-web-content should be downloaded (click top right and download as zip, unzip. You can now work in the folder "IT-empfehlungen"(https://github.com/dainst/ianus-web-content/tree/main/it-empfehlungen) and copy and move it as you wish. This is useful to get a general idea about the structure of the content and get a clear idea in what content you wish to alter.
ttps://github.com/dainst/ianus-web-content (button on the right top)
This can be done via the interface, github desktop or via git push/pull. In the case of the web interface, the folder from the file browser should be used for the drag/drop (see screenshot)
If you have changed a file locally proceed with the following steps. Alternatively, see B) for how to change content in the browser.
A short note should be added, e.g. which content has been added or changed. The default message is always uploaded content e.g., an extended description can be added. Care should be taken to ensure that the document is uploaded to the correct
Alternatively, you can just open the right chapter within the it-recommendations and add or change content there.
Navigate to the right file you want to edit and click on the little pencil in the top right corner.
Now edit the text or images directly in the markown documents. Make sure you stick to the structure of the documents, add headers if needed.
When you are satisfied with your changes, click "Commit changes". Add a short message describing what you did.
Click the green button to commit the changes.
Your changes have been committed and are shown immediately in your branch.
By clicking on "history" you can access the history of the record and track your changes in detail.
Repeat theses steps as needed to edit more than one record.
Once you are done, open a pull request by clicking on "Contribute", "Open pull request" in the branch's main navigation.
You can make sure to include all commits into the pull request, make sure they go to the main branch.
Click on "Create pull request" and in the following window add a short message explaining your edits, add references if needed and make sure if you wish to be added as an author or not. You can also add your name directly to the authors' header of the documents.
By clicking on "create pull request" again you have opened the pull request, for your edits to be merged to the main branch.
Done. A message is sent to the site administrator to apply the changes.