search

gofair-foundation / fip

FIP Wiki
https://gofair-foundation.github.io/fip/
Other
1 stars 4 forks source link

Add "Contributing" page to wiki #51

Closed norbertvandijk closed 7 months ago

norbertvandijk commented 9 months ago

Add "Contributing" page to wiki

norbertvandijk commented 9 months ago

How to contribute to the FIP wiki via Github

  1. Go to https://github.com/gofair-foundation/fip
  2. Creat a user profile if you don’t have one
  3. Create a fork of the gofair-foundation/fip in your own repository
  4. In the docs folder you will find the markdown files (filename.md), which are the files that are used to make the static pages on the wiki website, and the _static/img folder, which contain all the images that are shown in the wiki pages.
  5. If you wish to contribute to the text, first of all be sure that your fork is syncronised with the original GFF repository. To do so, open your fork, and click on “Sync fork”, then synchronise your fork by clicking on “update branch”.
  6. When the fork is synchronised, you can start editing the markdown files from your repository.
  7. Open the markdown file which correspond to the chapter you want to contribute to.
  8. Click on “edit this file” button on the top right of the page.
  9. The “edit” page will appear.
  10. After having introduced your changes, click on “commit changes”.
  11. Click on “pull request” button on the top left of the page, then “new pull request”
  12. At this point a new request has been pulled. The mantainers will revise your request and accept it if needed.

(Thank you Andrea)

norbertvandijk commented 9 months ago

@datara44 I suggest we write generic instructions as much as possible and avoid editor specific details of how to edit a markdown file since this can be done in a number of different code editors.

datara44 commented 9 months ago

I would put the link of the GFF fip github repo in the wiki page