Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Migrating to new theme and building the website again #31

Open
wants to merge 35 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
97e3c07
initial commit for contributing guidelines
jyoti-bhogal Sep 28, 2024
a11972e
Merge pull request #26 from researchsoft/contribute
jyoti-bhogal Sep 28, 2024
b9b92ba
:wrench: add steps to edit using VS Code
jyoti-bhogal Oct 2, 2024
bfe53a5
Merge pull request #29 from researchsoft/contribute
jyoti-bhogal Oct 2, 2024
ae4395b
:memo: add section headers and details on reporting bugs
jyoti-bhogal Oct 3, 2024
733baf2
add a table for pull request lables and their description
jyoti-bhogal Oct 3, 2024
ab5ca27
edit table of PR labels
jyoti-bhogal Oct 3, 2024
3c029be
:memo: add styleguide for git commit messages
jyoti-bhogal Oct 3, 2024
81ad4f4
:arrow_up: add beautifulhugo submodule
jyoti-bhogal Oct 4, 2024
05568e9
:memo: add new labels for pull request
jyoti-bhogal Oct 5, 2024
8e65188
add bug report issue form
jyoti-bhogal Oct 5, 2024
3b67c8c
add bug report issue template
jyoti-bhogal Oct 5, 2024
e17be4a
add bug report issue template
jyoti-bhogal Oct 6, 2024
f9c11c6
hyperlink bug report yaml
jyoti-bhogal Oct 6, 2024
664e52b
minor update in CONTRIBUTING.md
jyoti-bhogal Oct 14, 2024
c286a5f
add more details on how to submit bug report. add a table on issue la…
jyoti-bhogal Oct 14, 2024
76ae8b6
change layout for beautifulhugo theme
jyoti-bhogal Oct 16, 2024
035c361
Merge pull request #33 from researchsoft/contribute
jyoti-bhogal Oct 16, 2024
536afeb
Merge branch 'master' into dev
jyoti-bhogal Oct 16, 2024
2ae6c9d
Revert "change layout for beautifulhugo theme"
jyoti-bhogal Oct 16, 2024
f0b6365
Merge pull request #47 from researchsoft/contribute
jyoti-bhogal Oct 16, 2024
49a1e1c
rename index.md to _index.md to remove extra page titles
jyoti-bhogal Nov 27, 2024
ec48154
edit name of index.md file #54
jyoti-bhogal Nov 27, 2024
bdf7ab2
Merge pull request #52 from researchsoft/ananke
jyoti-bhogal Nov 27, 2024
e05dffa
change blog list structure to single page structure
jyoti-bhogal Nov 27, 2024
9b4c00f
Merge pull request #56 from researchsoft/ananke
jyoti-bhogal Nov 27, 2024
65003e1
delete index.md files from sub-folders in content/ folder
jyoti-bhogal Nov 27, 2024
1852ca9
Merge pull request #57 from researchsoft/ananke
jyoti-bhogal Nov 27, 2024
fab388d
add necessary css code to render markdown tables #58
jyoti-bhogal Nov 27, 2024
6e3db1e
Merge branch 'dev' into ananke
jyoti-bhogal Nov 27, 2024
9c42ee5
Merge pull request #59 from researchsoft/ananke
jyoti-bhogal Nov 27, 2024
2576fb1
install ananke theme defualt css files
jyoti-bhogal Nov 27, 2024
076b524
Merge pull request #60 from researchsoft/ananke
jyoti-bhogal Nov 27, 2024
1d40069
remove extra page titles #54
jyoti-bhogal Nov 27, 2024
49d086f
Merge pull request #61 from researchsoft/ananke
jyoti-bhogal Nov 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Bug Report
description:
title: "BUG: "
labels: [bug, needs triage]

body:
- type: checkboxes
id: checks
attributes:
lables: Prerequisite(s)
options:
- label: >
I have checked that this kind of issue has not already been reported.
required: true
- label: >
I have confirmed that this bug exists on the [main branch](https://github.com/researchsoft/website/tree/master)
- type: textarea
id: example
attributes:
label: Reproduce Example
description: Please provide a minimal, copy-pasteable code example.
validations:
required: true
- type: textarea
id: problem
attributes:
label: Issue Description
description: >
Please provide a description of the issue shown in the reproducible example.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: >
Please describe or show a code example of the expected behavior.
validations:
required: true
- type: textarea
id: additional-information
attributes:
label: Additional Information
description: >
Please provide any additional information.
validations:
required: false

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.vscode/
public/
.hugo_build.lock
.DS_Store
7 changes: 5 additions & 2 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
[submodule "themes/ananke"]
path = themes/ananke
url = https://github.com/budparr/gohugo-theme-ananke.git
path = themes/ananke
url = https://github.com/theNewDynamic/gohugo-theme-ananke.git
[submodule "themes/airspace"]
path = themes/airspace
url = https://github.com/themefisher/airspace-hugo.git
[submodule "themes/syna"]
path = themes/syna
url = https://git.okkur.org/syna
[submodule "themes/beautifulhugo"]
path = themes/beautifulhugo
url = https://github.com/halogenica/beautifulhugo.git
123 changes: 123 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Contributing to ReSA website

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to the ReSA website, which is hosted in the [ReSA Organization](https://github.com/researchsoft) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

This guide is inspired from [Atom's contributing guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md).

## How Can I Contribute?

### Reporting Bugs

This section guides you through submitting a bug report for Research Software Alliance. Following these guidelines helps maintainers understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.

Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report).

> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.


#### Before Submitting A Bug Report

* **Perform a [cursory search](https://github.com/researchsoft/website/issues?q=is%3Aopen+is%3Aissue)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.

#### How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. To report a bug, create an issue in the [website repository](https://github.com/researchsoft/website) by filling in the [bug report template](https://github.com/researchsoft/website//issues/new?assignees=&labels=bug%2Cneeds+triage&projects=&template=bug_report.yaml&title=BUG%3A+).

Explain the problem and include additional details to help maintainers reproduce the probelem:

* **Use clear and descriptive title** for the issue to identify the problem.
* **Describe the exact steps to reproduce the problem** n as many details as possible. For example: which command do you use in the terminal or in GitHub browser. Explain **how you did different steps, in addition to what you did**. For example: if you moved your cursor to next line, please mention if you used the mouse, or a keyboard button or a programming command in an IDE or GitHub browser.
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable text or code.
* **Describe the behavior you observed after followig the steps** and point out the exact problem in that behaviour/output.
* **Explain what behaviour you expected to see instead and why**.
* **Include screenshots or animated GIF/video** which show how you followed the steps and clearly demonstrate the problem in the output you observe.

Provide more context by answering the following questions:

* Can you reproduce the problem on another branch?
* Did the problem started happening recently i.e. in the new website (i.e. when theme is beautifulhugo) or was this a problem in the older version too (i.e. when theme is Syna)?
* **Can you reliably reproduce the issue?** If not, please describe how often the problem occurs and under what conditions does it normally occur.
* If the problem is related to working with files (e.g. opening or editing files), **does the problem occur for all the files and folders?** Does the problem occur only when working with local or remote files (e.g., on network drives), with specific type of file (e.g. .md or .html, etc.), with files with large size, with files with more number of lines, with files with a specific encoding? It there anything else specific about the files you are using?

### Suggesting Enhancements


#### Before Submitting An Enhancement Suggestion

#### How Do I Submit A (Good) Enhancement Suggestion?

### Pull Requests

### Styleguide (Git Commit Messages)

* Use the present tense ("Add feature" not "Added feature")
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
* Limit the first line to 72 characters or less
* Reference issues and pull requests liberally after the first line
* When only changing documentation, include `[ci skip]` in the commit title
* Consider starting the commit message with an applicable emoji:
* :art: `:art:` when improving the format/structure of the code
* :racehorse: `:racehorse:` when improving performance
* :non-potable_water: `:non-potable_water:` when plugging memory leaks
* :memo: `:memo:` when writing docs
* :penguin: `:penguin:` when fixing something on Linux
* :apple: `:apple:` when fixing something on macOS
* :checkered_flag: `:checkered_flag:` when fixing something on Windows
* :bug: `:bug:` when fixing a bug
* :fire: `:fire:` when removing code or files
* :green_heart: `:green_heart:` when fixing the CI build
* :white_check_mark: `:white_check_mark:` when adding tests
* :lock: `:lock:` when dealing with security
* :arrow_up: `:arrow_up:` when upgrading dependencies
* :arrow_down: `:arrow_down:` when downgrading dependencies
* :shirt: `:shirt:` when removing linter warnings

### Additional Notes

#### Issue Labels

| Label Name | Description
| --- | --- |
| `enhancement` | New feature or request |
| `bug` | Something is not working as expected |
| `question` | Further information is requested |
| `feedback` | General feedback more than bug reports or feature requests |
| `help wanted` | Extra attention is needed |
| `good first issue` | Less complex issues that would be good for new contributors |
| `blocked` | Issues blocked/dependent on other issues |
| `duplicate` | This issue or pull request already exists |
| `wontfix` | This will not be worked on|
| `inavlid` | This doesn't seem right (e.g. user error) |
| `wrong-repo` | Issues reported on the wrong repository |

#### Pull Request Labels

| Label Name | Description
| --- | --- |
| `work-in-progress` | Pull requests which are still being worked on, more changes will follow |
| `testing` | To test new or exisitng features, functions, or code |
| `needs-review`| To indicate that a pull request requires review |
| `under-review` | To indicate that a pull request is under review |

# How to install a new theme?

# How to make a table?

Here is a step-by-step demo about making a table:

# How to add an image?

Here is a step-by-step demo about how to add an image:

Step 1:

Step 2:
...

Step x: How to add caption?

Step (x+1): How to change size of the image?

Step (x+2): How to add alt text?
Loading