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

26 - Add frontend guides #353

Merged
merged 30 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from 24 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
851c669
first commit, adding temp files, placeholder content, and getting an …
Feb 28, 2024
efdc807
Readme Formatting
Feb 28, 2024
727deba
More readme updates
Feb 29, 2024
94ba941
test codeblock formatting
Mar 1, 2024
af3e426
formatting, links, logo tests
Mar 5, 2024
970bb84
formatting, removing second logo
Mar 5, 2024
d1c99b1
formatting
Mar 5, 2024
ae5db42
adding logos, fixing links
Mar 5, 2024
7731842
feat(Developer Guide): add Writting test cases section
MellyGray Mar 18, 2024
abbd345
feat(Developer Guide): add Coverage section
MellyGray Mar 19, 2024
1220a7d
feat(Developer Guide): add some notes about Writing test cases
MellyGray Mar 19, 2024
b509e4a
feat(Developer Guide): move React Testing Library link
MellyGray Mar 25, 2024
6d2c130
feat(Developer Guide): add missing details closing tag
MellyGray Mar 25, 2024
89713d6
feat(Frontend Guides): add the same CODE_OF_CONDUCT as the main Datav…
MellyGray Mar 27, 2024
98ba0bb
Merge pull request #349 from IQSS/docs-326-developer-guide-writing-te…
ekraffmiller Mar 28, 2024
37cbd32
feat(Frontend Guides): address all TODOs from the CONTRIBUTING.md file
MellyGray Apr 1, 2024
ea6a12a
feat(Frontend Guides): address all TODOs in the README
MellyGray Apr 1, 2024
6916a34
feat(Frontend Guides): update issues templates
MellyGray Apr 1, 2024
6831b7c
feat(Frontend Guides): remove AUTHORS.md
MellyGray Apr 1, 2024
aeece97
feat(Frontend Guides): remove empty CHANGELOG
MellyGray Apr 1, 2024
1fdba1f
Merge branch 'docs/26-add-frontend-guides' of https://github.com/IQSS…
MellyGray Apr 1, 2024
75ed003
Merge branch 'develop' of https://github.com/IQSS/dataverse-frontend …
MellyGray Apr 1, 2024
60b6af2
feat(Developer Guide): add note about .npmrc.example
MellyGray Apr 1, 2024
c54082a
feat(Developer Guide): remove unused links
MellyGray Apr 1, 2024
07fb761
feat(Frontend Guides): fix .github files to create issues
MellyGray Apr 1, 2024
c9fedaa
feat(Frontend Guides): fix Typescript style guide link
MellyGray Apr 16, 2024
8824d90
feat(Frontend Guides): add GitHub container registry link
MellyGray Apr 16, 2024
abbb137
feat(Fronted Guides): link e2e new issue to address the failures
MellyGray Apr 16, 2024
f89980a
Merge branch 'develop' of https://github.com/IQSS/dataverse-frontend …
MellyGray Apr 16, 2024
a3fa006
fix: merge conflict arrows
MellyGray Apr 17, 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
41 changes: 32 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,46 @@
# What steps does it take to reproduce the issue?
---
name: Bug report
about: Did you encounter something unexpected or incorrect in the Dataverse software?
We'd like to hear about it!
title: ''
labels: 'Type: Bug'
assignees: ''

## When does this issue occur?
---

## Which section(s) does it occurs on?
<!--
Thank you for contributing to the Dataverse Project through the creation of a bug report!

## What happens?
WARNING: If this is a security issue it should be reported privately to [email protected]

## To whom does it occur (all users, curators, superusers)?
More information on bug issues and contributions can be found in the "Contributing to Dataverse Frontend" page:
https://github.com/IQSS/dataverse-frontend/blob/develop/CONTRIBUTING.md

## What did you expect to happen?
Please fill out as much of the template as you can.
Start below this comment section.
-->

## Which version of Dataverse Frontend are you using?
**What steps does it take to reproduce the issue?**

## Any related open or closed issues to this bug report?
- When does this issue occur?

# Screenshots:
- Which page(s) does it occur on?

- What happens?

- To whom does it occur (all users, curators, superusers)?

- What did you expect to happen?

**Which version of Dataverse Frontend are you using?**

**Any related open or closed issues to this bug report?**

**Screenshots:**

No matter the issue, screenshots are always welcome.

To add a screenshot, please use one of the following formats and/or methods described here:

- https://help.github.com/en/articles/file-attachments-on-issues-and-pull-requests
-
31 changes: 24 additions & 7 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
## Overview of the Feature Request
---
name: Feature request
about: Suggest an idea or new feature for the Dataverse software!
title: 'Feature Request/Idea:'
labels: 'Type: Feature'
assignees: ''
---

## What kind of user is the feature intended for?
<!--
Thank you for contributing to the Dataverse Project through the creation of a feature request!

(Example users roles: Curator, Depositor, Guest, Superuser, Sysadmin)
More information on ideas/feature requests and contributions can be found in the "Contributing to Dataverse" page:
https://github.com/IQSS/dataverse/blob/develop/CONTRIBUTING.md#ideasfeature-requests

## What inspired the request?
Please fill out as much of the template as you can.
Start below this comment section.
-->

## What existing behavior do you want changed?
**Overview of the Feature Request**

## Any brand new behavior do you want to add to Dataverse?
**What kind of user is the feature intended for?**
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)

## Any open or closed issues related to this feature request?
**What inspired the request?**

**What existing behavior do you want changed?**

**Any brand-new behavior do you want to add to Dataverse?**

**Any open or closed issues related to this feature request?**
16 changes: 8 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
## What this PR does / why we need it:
**What this PR does / why we need it**:

## Which issue(s) this PR closes:
**Which issue(s) this PR closes**:

- Closes #
Closes #

## Special notes for your reviewer:
**Special notes for your reviewer**:

## Suggestions on how to test this:
**Suggestions on how to test this**:

## Does this PR introduce a user interface change? If mockups are available, please link/include them here:
**Does this PR introduce a user interface change? If mockups are available, please link/include them here**:

## Is there a release notes update needed for this change?:
**Is there a release notes update needed for this change?**:

## Additional documentation:
**Additional documentation**:
79 changes: 79 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,82 @@ yarn-error.log*
/dev-env/dataverse
/dev-env/dataverse-sample-data
/packages/design-system/.nyc_output


# Compiled source #
###################
*.com
*.class
*.dll
*.exe
*.o
*.so
_site/

# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip

# Logs and databases #
######################
*.log
*.sql
*.sqlite

# OS generated files #
######################
.DS_Store
.DS_Store?
.Spotlight-V100
.Trashes
Icon?
ehthumbs.db
Thumbs.db

# Vim swap files #
##################
*.swp

# Python #
#################
*.pyc
*.egg-info/
__pycache__/
*.py[cod]
.env
.python-version

# pyenv #
#########
.python-version

# Django #
#################
*.egg-info
.installed.cfg

# Unit test / coverage reports
#################
htmlcov/
.tox/
.coverage
.cache
nosetests.xml
coverage.xml

# Front-End #
#############
node_modules/
bower_components/
.grunt/
src/vendor/
dist/
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

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

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at support at dataverse dot org. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
Loading
Loading