Skip to content
This repository has been archived by the owner on Sep 29, 2024. It is now read-only.

Editor Configuration and Linting #20

Merged
merged 10 commits into from
Mar 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
charset = utf-8
indent_size = 2
indent_style = space
quote_type = single

41 changes: 20 additions & 21 deletions .github/CODESTYLE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Code Style

The following is a general guide on how to style your work so that the project
remains consistent throughout all files. Please read this document in it's entirety
and refer to it throughout the development of your contribution.
Expand All @@ -7,9 +8,8 @@ and refer to it throughout the development of your contribution.
2. [Commit Message Guidelines](#commit-message-guidelines)
3. [Markdown Guidelines](#markdown-guidelines)



## General Guidelines

Listed is a example class used demonstrate general rules you should follow throughout the development of your contribution.

- Docstrings are to follow {{DOCSTRING_FORMAT}}
Expand All @@ -19,40 +19,39 @@ Listed is a example class used demonstrate general rules you should follow throu
code example
```



## Markdown Guidelines

Currently, documentation for this project resides in markdown files.
- Headings are to be separated with 3 lines
- Use of HTML comments is appreciated
- Use of HTML is permitted
- [reference style links](https://www.markdownguide.org/basic-syntax/#reference-style-links) are not required by are appreciated
- Exceedingly long lines are to be broken
- The indents are to be 4 spaces

- Headings are to be separated with 3 lines
- Use of HTML comments is appreciated
- Use of HTML is permitted
- [reference style links](https://www.markdownguide.org/basic-syntax/#reference-style-links) are not required by are appreciated
- Exceedingly long lines are to be broken
- The indents are to be 4 spaces

```markdown
<!--example markdown document-->

# Section

Lorem ipsum dolor sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea
commodo consequat. Duis aute irure dolor in
reprehenderit in voluptate velit esse cillum dolore eu
fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, sunt in culpa qui officia deserunt mollit
sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea
commodo consequat. Duis aute irure dolor in
reprehenderit in voluptate velit esse cillum dolore eu
fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, sunt in culpa qui officia deserunt mollit
anim id est laborum. found [Lorem Ipsum Generator]



# Section 2

<ul>
<li> Apple
<li> Orange
<li> Pineapple
</ul>



[Lorem Ipsum Generator]: https://loremipsum.io/generator/
```
24 changes: 12 additions & 12 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
- Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities
Expand Down Expand Up @@ -105,7 +105,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
Expand All @@ -124,4 +124,4 @@ enforcement ladder](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
https://www.contributor-covenant.org/translations.
6 changes: 1 addition & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ email, or any other method with the owners of this repository before making a ch

Please note we have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions with the project.



## Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
Expand All @@ -17,11 +15,9 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in
4. You may merge the Pull Request once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.



## Issue Report Process

1. Go to the project's issues.
2. Select the template that better fits your issue.
3. Read the instructions carefully and write within the template guidelines.
4. Submit it and wait for support.
4. Submit it and wait for support.
37 changes: 16 additions & 21 deletions .github/ISSUE_TEMPLATE/1-bug-report.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,61 @@
---
name: "Bug Report"
about: "Report an issue to help the project improve."
title: "[Bug] "
labels: "Type: Bug"
name: 'Bug Report'
about: 'Report an issue to help the project improve.'
title: '[Bug] '
labels: 'Type: Bug'
assignees: caffeine-addictt

---

# Bug report

Your issue may already be reported!
Please check out our [active issues](https://github.com/caffeine-addictt/nyp_y2_fullstack/issues) before creating one.



## Expected Behavior

<!--
If you're describing a bug, tell us what should happen
If you're suggesting a change/improvement, tell us how it should work

Please include screenshots and/or code snippets if applicable
-->



## Current Behavior

<!--
If describing a bug, tell us what happens instead of the expected behavior
If suggesting a change/improvement, explain the difference from current behavior

Please include screenshots and/or code snippets if applicable
-->



## Is this a regression?

<!--
Did this behaviour use to work in previous versions?
If yes, what is the latest version where this behaviour is not present?
-->



## Possible Solution

<!--
Not obligatory, but suggest a fix/reason for the bug
or ideas how to implement the addition or change
-->



## Steps to Reproduce (for bugs)

<!--
Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.
-->

1.
2.
3.
4.



## Context

<!--
How has this issue affected you?
What are you trying to accomplish?
Expand All @@ -70,11 +65,11 @@ Providing context helps us come up with a solution that is most useful in the re
Please include screenshots and/or code snippets if applicable
-->



## Your Environment

<!--
Include as many relevant details about the environment you experienced the bug in
-->
* Version used:
* Operating System and version (desktop or mobile):

- Version used:
- Operating System and version (desktop or mobile):
22 changes: 9 additions & 13 deletions .github/ISSUE_TEMPLATE/2-failing-test.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,36 @@
---
name: "Failing Test"
about: "Report failing tests or CI jobs."
title: "[Test] "
labels: "Type: Test"
name: 'Failing Test'
about: 'Report failing tests or CI jobs.'
title: '[Test] '
labels: 'Type: Test'
assignees: caffeine-addictt

---

# Failing Test

Your issue may already be reported!
Please check out our [active issues](https://github.com/caffeine-addictt/nyp_y2_fullstack/issues) before creating one.



## Which Jobs/Tests are Failing?
*


-

## Reason for Failure

<!--
Why is/are this/these job/test(s) failing?
What are we missing to make it pass?
-->



## Media Prove

<!--
If applicable, add screenshots or code snippets to explain the issue
If not applicable, remove this field
-->



## Additional Context

<!--
Any other extra context or information
-->
17 changes: 7 additions & 10 deletions .github/ISSUE_TEMPLATE/3-docs-bug.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
---
name: "Documentation or README.md issue report"
name: 'Documentation or README.md issue report'
about: "Report an issue in the project's documentation or README.md file."
title: ""
labels: "Documentation"
title: ''
labels: 'Documentation'
assignees: caffeine-addictt

---

# Documentation Issue Report

Your issue may already be reported!
Please check out our [active issues](https://github.com/caffeine-addictt/nyp_y2_fullstack/issues) before creating one.



## Describe the Bug

<!--
A clear and concise description of the bug
-->



## Steps to Reproduce

<!--
e.g.:
1. Navigate to docs/x
Expand All @@ -33,9 +31,8 @@ e.g.:
3.
4.



## Additional Context

<!--
Any other extra context or information
-->
Loading