Contributing¶
We welcome contributions helping us achieve the goal of this website.
Why contribute?
- To (help show) we care about our users
- To (help show) we care about quality
- To (help show) yourself a good team player
Thanks for considering to contribute and reading this!
Here we discuss how to contribute.
| What do you want to do | How to do it |
|---|---|
| Share your knowledge in general terms | Create an issue |
| Share your knowledge by adding content to an existing page | Modifying content |
| Share your knowledge by adding content to a new page | Add new page |
| Share your knowledge by modifying content | Modifying content |
| Report mistakes | Create an issue |
| Suggest improvements in general terms | Create an issue |
| Suggest improvements by modifying content | Modifying content |
| Give anonymous feedback | Go to this form |
See the contribution questions if you still have a question about contributing.
Create an issue¶
Issues are 'things that need to be done', for example:
- ideas
- feedback
- messages
Anyone with a GitHub account can create an issue.
How to create an issue?
- Log in to your GitHub account
- Go to the issues
- Click on the green button 'Create issue'
Click on 'Create issue'
- Write a title and description
- At the bottom of the page, click the green button 'Create'
Click on 'Create'
Thanks!
These issues will be discussed in a meeting and/or in the issue itself.
Ideas that improve the experience of NAISS users trying to use our resources are likely to be accepted.
Modify content¶
The goal of this website is to document how to use our resources. We welcome any contribution that helps us achieve this goal.
Ideally, such a contribution also ..
- follows all standards set by the continuous integration tools (e.g. use 4 spaces for indentation).
Anyone with a GitHub account can suggest changes by clicking the 'Edit' button, which is present on each document page.
How to create an issue?
- On any documentation page, click 'Edit'
Click 'Edit'
- Log in to your GitHub account
- In the next page, click 'Edit this file'
Click 'Edit this file'
-
Modify the Markdown file
-
Click on the green 'Commit changes' button
What follows depends on who you are:
- If you are not NAISS staff, you will be asked to create a fork
and create a pull request. Whatever this is, yes, do that
.
After that, the NAISS staff will take a look at your suggestion - If you are NAISS staff, your changes are directly added. It takes several minutes until this is visible on the website.
Add new page¶
The goal of the NAISS documentation is to document how to use our resources. We welcome any contribution that helps us achieve this goal.
Ideally, such a contribution also ..
- follows all standards set by the continuous integration tools (e.g. use 4 spaces for indentation).
- puts the files in reasonable folders (see Where to put files? below)
If it does not, we'll fix it for you
How to add a new page?
- Go to the GitHub repository behind the NAISS documentation webpage, by clicking on the word 'GitHub'
Click on the word 'GitHub'
-
In GitHub repository, navigate to the folder you want to add a file, by clicking on the folders' names
-
On any documentation page, click 'Add new file'
- Specify a name for the file and write is content in Markdown
- Click on the green 'Commit changes' button
What follows depends on who you are:
- If you are not NAISS staff, you will be asked to create a fork
and create a pull request. Whatever this is, yes, do that .
After that, the NAISS staff will take a look at your suggestion
- If you are NAISS staff, your changes are directly added. It takes several minutes until this is visible on the website.
Contribution questions¶
How long does it take until I see my changes on the website?¶
When your changes are committed to our main branch, it takes several minutes until these are live.
One can see the process at the Actions page of this repository.
What if I make a mistake?¶
This repository has version control. Hence, if needed, we can undo any mistake.
It is more typical that mistakes are fixed.
Where to put files in this repository?¶
TODO: add folder structure from meeting notes
Which git branch should I use?¶
Submitting to the main branch is fine. Thanks!