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 8 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
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

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

## Additional documentation:
## Additional documentation:
10 changes: 10 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# Looking for support? We want to help

Please post your question to X (#) using the Timber tag.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this X/Timber stuff?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the SUPPORT.md file because the file seemed like a template with no real information, and we already cover the various channels through which people can contact us in the README, such as Google Groups, Zulip, etc.


## Other places

You can use [GitHub Discussions](#) to open up questions and engage in discussions with the contributors and other users.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we plan to use GitHub Discussion? That's fine. I'm just curious. 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I asked the frontend team, and for the moment, we'll stick with Zulip.


Please don't post to the [EXAMPLE forum](#). You might see a response, but it will just redirect you to either GitHub (for bugs/issues) or StackOverflow (for usage/support questions).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this line? Don't post somewhere? Stackoverflow? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the SUPPORT.md file because the file seemed like a template with no real information, and we already cover the various channels through which people can contact us in the README, such as Google Groups, Zulip, etc.

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/
22 changes: 22 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Below is a list of people and organizations that have contributed

# to the Dataverse Frontend project. Names should be added to the list like so:

#

# Name/Organization <email address>

#

# Anyone who has contributed to the Dataverse Frontend project in any way (not

# limited to submitting PRs) is welcome to submit a PR to add their

# name to this file.

#

# Thanks to everyone for your contributions!

Harvard University IQSS Team
FirstName LastName <firstname.lastname@example.com>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the file for now since it was just a template that needs to be filled with real information.

There's an issue to work on it:

However, at the moment, it doesn't seem like a critical file in the Frontend Guides, and we have some other issues related to the frontend guides in this Sprint with higher priority than the AUTHORS file.

33 changes: 33 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Change Log

Resources for generating a changelog:

[skywinder/Github-Changelog-Generator](https://github.com/skywinder/Github-Changelog-Generator) - generates a full changelog that overwrites the existing CHANGELOG.md.

[hzalaz/wt-oss-milestone-changelog](https://github.com/hzalaz/wt-oss-milestone-changelog) - generates a snippet of Markdown that can be added to a CHANGELOG.md.

[conventional-changelog/conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) - generates a full changelog based on commit history with the option to append to an existing changelog.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest moving these elsewhere for the final changelog.

There's also https://keepachangelog.com (not for generating, but just a high level of why a changelog is a good idea).


<!-- CHANGELOG.md -->

All notable changes to this project will be documented in this file.
We follow the [Semantic Versioning 2.0.0](http://semver.org/) format.

## x.y.z - YYYY-MM-DD

### Added

- Lorem ipsum dolor sit amet

### Deprecated

- Nothing.

### Removed

- Nothing.

### Fixed

- Nothing.
-
142 changes: 142 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
# Dataverse&reg; Code of Conduct
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the Code of Conduct be the same as https://github.com/IQSS/dataverse/blob/develop/CODE_OF_CONDUCT.md ? (It's what we link to from https://dataverse.org as well.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! I replaced it with the CODE_OF_CONDUCT from the main Dataverse repo


## Our Pledge

[Institute for Quantitative Social Science](http://www.iq.harvard.edu/) (IQSS)

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible 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.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

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,
and learning from the experience
- 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
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
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Scope

We expect everyone on the IQSS Dataverse team, and those contributing to our open source community, to exhibit
these behaviors and abide by applicable federal laws and Harvard University policies.

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## What We Strive For

At IQSS, we strive to create a welcoming and inclusive culture that empowers people to share, preserve, cite, explore, and analyze research data. That kind of atmosphere requires an open exchange of ideas balanced by thoughtful guidelines. Examples of behavior that contributes to a positive environment for our open source 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, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community and public

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Enforcement Guidelines

<!-- TODO: Email -->

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at IQSS (EMAIL).
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
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
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

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

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.
Loading
Loading