|
| 1 | +# Contributing to ReSA website |
| 2 | + |
| 3 | +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +This guide is inspired from [Atom's contributing guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md). |
| 8 | + |
| 9 | +## How Can I Contribute? |
| 10 | + |
| 11 | +### Reporting Bugs |
| 12 | + |
| 13 | +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:. |
| 14 | + |
| 15 | +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). |
| 16 | + |
| 17 | +> **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. |
| 18 | +
|
| 19 | + |
| 20 | +#### Before Submitting A Bug Report |
| 21 | + |
| 22 | +* **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. |
| 23 | + |
| 24 | +#### How Do I Submit A (Good) Bug Report? |
| 25 | + |
| 26 | +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+). |
| 27 | + |
| 28 | +Explain the problem and include additional details to help maintainers reproduce the probelem: |
| 29 | + |
| 30 | +* **Use clear and descriptive title** for the issue to identify the problem. |
| 31 | +* **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. |
| 32 | +* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable text or code. |
| 33 | +* **Describe the behavior you observed after followig the steps** and point out the exact problem in that behaviour/output. |
| 34 | +* **Explain what behaviour you expected to see instead and why**. |
| 35 | +* **Include screenshots or animated GIF/video** which show how you followed the steps and clearly demonstrate the problem in the output you observe. |
| 36 | + |
| 37 | +Provide more context by answering the following questions: |
| 38 | + |
| 39 | +* Can you reproduce the problem on another branch? |
| 40 | +* 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)? |
| 41 | +* **Can you reliably reproduce the issue?** If not, please describe how often the problem occurs and under what conditions does it normally occur. |
| 42 | +* 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? |
| 43 | + |
| 44 | +### Suggesting Enhancements |
| 45 | + |
| 46 | + |
| 47 | +#### Before Submitting An Enhancement Suggestion |
| 48 | + |
| 49 | +#### How Do I Submit A (Good) Enhancement Suggestion? |
| 50 | + |
| 51 | +### Pull Requests |
| 52 | + |
| 53 | +### Styleguide (Git Commit Messages) |
| 54 | + |
| 55 | +* Use the present tense ("Add feature" not "Added feature") |
| 56 | +* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") |
| 57 | +* Limit the first line to 72 characters or less |
| 58 | +* Reference issues and pull requests liberally after the first line |
| 59 | +* When only changing documentation, include `[ci skip]` in the commit title |
| 60 | +* Consider starting the commit message with an applicable emoji: |
| 61 | + * :art: `:art:` when improving the format/structure of the code |
| 62 | + * :racehorse: `:racehorse:` when improving performance |
| 63 | + * :non-potable_water: `:non-potable_water:` when plugging memory leaks |
| 64 | + * :memo: `:memo:` when writing docs |
| 65 | + * :penguin: `:penguin:` when fixing something on Linux |
| 66 | + * :apple: `:apple:` when fixing something on macOS |
| 67 | + * :checkered_flag: `:checkered_flag:` when fixing something on Windows |
| 68 | + * :bug: `:bug:` when fixing a bug |
| 69 | + * :fire: `:fire:` when removing code or files |
| 70 | + * :green_heart: `:green_heart:` when fixing the CI build |
| 71 | + * :white_check_mark: `:white_check_mark:` when adding tests |
| 72 | + * :lock: `:lock:` when dealing with security |
| 73 | + * :arrow_up: `:arrow_up:` when upgrading dependencies |
| 74 | + * :arrow_down: `:arrow_down:` when downgrading dependencies |
| 75 | + * :shirt: `:shirt:` when removing linter warnings |
| 76 | + |
| 77 | +### Additional Notes |
| 78 | + |
| 79 | +#### Issue Labels |
| 80 | + |
| 81 | +| Label Name | Description |
| 82 | +| --- | --- | |
| 83 | +| `enhancement` | New feature or request | |
| 84 | +| `bug` | Something is not working as expected | |
| 85 | +| `question` | Further information is requested | |
| 86 | +| `feedback` | General feedback more than bug reports or feature requests | |
| 87 | +| `help wanted` | Extra attention is needed | |
| 88 | +| `good first issue` | Less complex issues that would be good for new contributors | |
| 89 | +| `blocked` | Issues blocked/dependent on other issues | |
| 90 | +| `duplicate` | This issue or pull request already exists | |
| 91 | +| `wontfix` | This will not be worked on| |
| 92 | +| `inavlid` | This doesn't seem right (e.g. user error) | |
| 93 | +| `wrong-repo` | Issues reported on the wrong repository | |
| 94 | + |
| 95 | +#### Pull Request Labels |
| 96 | + |
| 97 | +| Label Name | Description |
| 98 | +| --- | --- | |
| 99 | +| `work-in-progress` | Pull requests which are still being worked on, more changes will follow | |
| 100 | +| `testing` | To test new or exisitng features, functions, or code | |
| 101 | +| `needs-review`| To indicate that a pull request requires review | |
| 102 | +| `under-review` | To indicate that a pull request is under review | |
| 103 | + |
| 104 | +# How to install a new theme? |
| 105 | + |
| 106 | +# How to make a table? |
| 107 | + |
| 108 | +Here is a step-by-step demo about making a table: |
| 109 | + |
| 110 | +# How to add an image? |
| 111 | + |
| 112 | +Here is a step-by-step demo about how to add an image: |
| 113 | + |
| 114 | +Step 1: |
| 115 | + |
| 116 | +Step 2: |
| 117 | +... |
| 118 | + |
| 119 | +Step x: How to add caption? |
| 120 | + |
| 121 | +Step (x+1): How to change size of the image? |
| 122 | + |
| 123 | +Step (x+2): How to add alt text? |
0 commit comments