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

Orcid api #843

Open
wants to merge 132 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
132 commits
Select commit Hold shift + click to select a range
93966de
Create CONTRIBUTING.md
fdiblen Aug 25, 2022
94c11c9
Update CONTRIBUTING.md
fdiblen Aug 25, 2022
7c6736a
Create CODE_OF_CONDUCT.md
fdiblen Aug 25, 2022
0756dd2
Update PULL_REQUEST_TEMPLATE.md
fdiblen Aug 25, 2022
e3cdb39
Update PULL_REQUEST_TEMPLATE.md
fdiblen Aug 25, 2022
13ca53d
Update README.md
fdiblen Aug 25, 2022
fbbfda4
Update README.md
fdiblen Aug 25, 2022
e0b5285
Apply suggestions from code review
fdiblen Aug 25, 2022
611fde7
Update README.md
fdiblen Aug 25, 2022
8d19d8d
bind width to a model to get around vue warning
Aug 26, 2022
1ae44c3
use bind instead of model
Aug 26, 2022
c883135
use literal instead of variable
Aug 26, 2022
21bec90
adding fill width for download and add more button
Aug 25, 2022
a568118
Add basic Cypress end-to-end testing
abelsiqueira Aug 18, 2022
db42e99
Implements @fdiblen's suggestions from the PR review
abelsiqueira Aug 25, 2022
b068e1c
Implement InfoDialog for Identifiers screen
abelsiqueira Aug 24, 2022
aa24432
move lastname i icons outside
fdiblen Aug 25, 2022
fe20d44
add info dialog for author edit card and improve infodialog
fdiblen Aug 29, 2022
7319801
update info dialog example rendering
fdiblen Aug 29, 2022
01a0390
fix linter issues
fdiblen Aug 29, 2022
9d48b9f
Update src/components/AuthorCardEditing.vue
fdiblen Aug 29, 2022
6797816
Update src/components/AuthorCardEditing.vue
fdiblen Aug 29, 2022
869edf1
update title for authors last name fields
fdiblen Aug 29, 2022
9ba319c
Update src/components/AuthorCardEditing.vue
fdiblen Aug 29, 2022
eba127c
Update src/components/AuthorCardEditing.vue
fdiblen Aug 29, 2022
9ef1669
Add remove button to view cards in Author and Identifiers screens
abelsiqueira Aug 25, 2022
55b6e50
update field names in author info dialog
fdiblen Aug 29, 2022
3cd394e
fix url format for IdentifierCardEditing
fdiblen Aug 29, 2022
7cedece
fix url format for ScreenAbstract
fdiblen Aug 29, 2022
4338ef0
fix url format for ScreenIdentifiers
fdiblen Aug 29, 2022
a607e80
fix url format for ScreenKeywords
fdiblen Aug 29, 2022
5829cb0
fix url format for ScreenLicense
fdiblen Aug 29, 2022
739f653
fix url format for ScreenRelatedResources
fdiblen Aug 29, 2022
411c64e
fix url format for ScreenStart
fdiblen Aug 29, 2022
a78a598
fix url format for ScreenVersionSpecific
fdiblen Aug 29, 2022
15c7e61
Update src/components/ScreenStart.vue
fdiblen Aug 29, 2022
85e24c7
upgrade setup-node action to V3
fdiblen Aug 29, 2022
987ede3
remove unused SchemaGuideLink component
fdiblen Aug 29, 2022
0bf0be6
Remove tooltips from author card
abelsiqueira Aug 29, 2022
28a52e5
add confirmation dialog to reset the form
fdiblen Aug 29, 2022
66312e9
make linter happier
fdiblen Aug 29, 2022
6947dec
change $q to q to remove vue warning
Aug 26, 2022
5aee6bf
fix extra margin
fdiblen Aug 29, 2022
e4b2790
Update CITATION.cff with information of v2.0.4
abelsiqueira Aug 29, 2022
9172fb1
Update .zenodo.json with v2.0.4 information
abelsiqueira Aug 29, 2022
3c68707
Update package.json with version 2.0.4
abelsiqueira Aug 29, 2022
e2b7557
Update package-lock.json with version 2.0.4
abelsiqueira Aug 29, 2022
66094f0
Update footer and app versions to 2.0.4
abelsiqueira Aug 29, 2022
74b458e
zenodraft/action updated the file CITATION.cff with the prereserved doi
Aug 29, 2022
3df921c
Update making a release on README.dev.md
abelsiqueira Aug 29, 2022
95ede7f
Add Jest coverage using codecov
abelsiqueira Oct 4, 2022
c3bfdc8
Add Codecov badge
abelsiqueira Oct 4, 2022
232aa8c
Use istanbul/nyc to add Cypress coverage
abelsiqueira Oct 4, 2022
ac6f458
Add validation unit tests
abelsiqueira Oct 4, 2022
453d63f
Use test:unit:coverage on test.yml
abelsiqueira Oct 5, 2022
594b9be
Test creation of complete CFF
abelsiqueira Oct 5, 2022
c089b77
Change showHelpDialogXYZ to showXYZHelp to keep it uniform
abelsiqueira Oct 5, 2022
789348a
Add data-cy to info-icons and tests that the dialogs exist, open, and…
abelsiqueira Oct 5, 2022
9381b14
Merge InfoDialog with its corresponding q-icon
abelsiqueira Oct 5, 2022
446556c
Aggregate helpData in a single file and remove dependency to data fro…
abelsiqueira Oct 6, 2022
4a6bebd
Add preview link to README.md info for developers
abelsiqueira Oct 6, 2022
ac3393b
Refactor form to Layout level
abelsiqueira Oct 6, 2022
d3428b7
Add Cypress tests for navigation
abelsiqueira Oct 14, 2022
7ea1058
Fix: accessing finish-advanced now enables advanced mode (#738)
abelsiqueira Oct 14, 2022
5e483d2
Add Jest tests for app.ts to check navigation
abelsiqueira Oct 14, 2022
df40909
Enable custom commands in Cypress and create dataCy
abelsiqueira Oct 14, 2022
b317efa
Check errors on every page on Cypress
abelsiqueira Oct 14, 2022
f3a59fc
Update actions/checkout to v3
abelsiqueira Oct 17, 2022
0682cc2
Add Cypress tests for card buttons in author and identifier and keywo…
abelsiqueira Oct 17, 2022
2907d93
Test all fields of cffstr
abelsiqueira Oct 3, 2022
d6c2eb1
Fix navigateDirect tests
abelsiqueira Oct 18, 2022
dc6f5c0
Change tests to use a single finish page
abelsiqueira Oct 18, 2022
fa0eaa9
Refactor finish minimum and advance into a single finish screen
abelsiqueira Oct 18, 2022
aadbcb1
Change screen level validation to use the error filtering system
abelsiqueira Oct 18, 2022
3aa722d
[skip ci] Add a comment explaining why we don't use the new match in …
abelsiqueira Oct 18, 2022
cba3201
Remove h2 and h3 used as labels for inputs and use accessible labels …
abelsiqueira Oct 24, 2022
6eedf88
Disable video recording on Cypress
abelsiqueira Oct 24, 2022
71093e5
Aggregate radio buttons with fieldset
abelsiqueira Oct 27, 2022
73cc3c4
Add aria-label to many places and remove wrong tabindex=-1
abelsiqueira Oct 27, 2022
3b5fde9
Add alt to images
abelsiqueira Oct 27, 2022
828d576
Improve accessibility of InfoDialog
abelsiqueira Oct 27, 2022
dbd8bc7
Improve accessibility of landing page
abelsiqueira Oct 27, 2022
c692d4d
Add skip to main link
abelsiqueira Oct 27, 2022
52badad
Reset focus after route change
abelsiqueira Oct 27, 2022
840c614
Remove user-scalable=no and maximum-scale=1
abelsiqueira Oct 27, 2022
964bef6
Change or add roles to various elements
abelsiqueira Oct 27, 2022
c0ad5e0
Update to Quasar 2.10.1 to fix bug in ORCID field
abelsiqueira Oct 31, 2022
9e87923
Stop using classes `error`, `has-error` and `invalid`
abelsiqueira Oct 27, 2022
c582f2c
Create BannerErrorMessages to generalize screen level error messages
abelsiqueira Oct 27, 2022
3aab591
Refactor Stepper into a `v-for` loop
abelsiqueira Oct 27, 2022
6a9a234
Add cffinit logo on the top left side with a link to the landing page
abelsiqueira Oct 27, 2022
fb049a5
Refactor preview component
abelsiqueira Oct 27, 2022
cc6d6f8
Revamp the UI of the main objects, including layout, preview, header …
abelsiqueira Nov 1, 2022
d7a099e
Revamp the UI of the Authors screen
abelsiqueira Nov 1, 2022
d70c3f5
Revamp the UI of the Identifiers screen
abelsiqueira Nov 1, 2022
3852428
Revamp the UI of the Keywords screen
abelsiqueira Nov 1, 2022
1179e11
Small tweaks and cleanup related to the UI revamp
abelsiqueira Nov 1, 2022
240bf4e
Improve tab flow
abelsiqueira Nov 1, 2022
35f692f
Upload screenshot of failures in Cypress
abelsiqueira Nov 1, 2022
a3e0085
Main does not need to be focusable anymore
abelsiqueira Nov 1, 2022
159fa23
Change negative color to improve contrast in form cards
abelsiqueira Nov 1, 2022
c870903
Remove ORCID hint
abelsiqueira Nov 1, 2022
ba0695a
Pressing the stepper actions, skipToMain, or the stepper will focus t…
abelsiqueira Nov 21, 2022
51fdbcb
Change publish to true in zenodraft action and update README.dev.md
abelsiqueira Nov 21, 2022
3b97476
Release 2.1.0
abelsiqueira Nov 21, 2022
6bc1e71
zenodraft/action updated the file CITATION.cff with the prereserved doi
Nov 21, 2022
e751ee3
Add more information on how to release and fix release 2.1.0 dates
abelsiqueira Nov 21, 2022
7ae5d5f
Improve, add or change various texts trying to increase user experience
abelsiqueira Nov 22, 2022
e0754b6
Fix: prevent refresh when pressing enter on keywords screen
abelsiqueira Nov 25, 2022
db111dc
Remove leftover from old preview in Header
abelsiqueira Dec 19, 2022
a664378
Use Quasar notification instead of tooltip for copy
abelsiqueira Dec 19, 2022
7d86c70
Remove concept of basic/advanced. All steps are present in the stepper
abelsiqueira Nov 22, 2022
5e41480
Change visual feedback on stepper to only show errors from previous s…
abelsiqueira Nov 22, 2022
f89bad2
Keep the visited screens on state to show in the stepper
abelsiqueira Nov 25, 2022
76ac031
Don't say optional on Finish step
abelsiqueira Jan 3, 2023
edfeced
Limit movement based on validation
abelsiqueira Nov 29, 2022
62cb12e
There was a leftover .only on cypress tests
abelsiqueira Jan 3, 2023
d226d64
Create screen for extra CFF fields
abelsiqueira Jan 3, 2023
eb437ad
Add screen to paste existing CFF and document rules for parsing
abelsiqueira Jan 6, 2023
4aba4a4
Fix last-name to family-names in cffstr test
abelsiqueira Jan 6, 2023
5737179
Add preview of the releases to netlify
abelsiqueira Jan 9, 2023
a18b788
Better error evaluation and feedback for Extra CFF Fields
abelsiqueira Jan 10, 2023
089a89d
Treat parsing of {{}} and similar objects
abelsiqueira Jan 16, 2023
4fd4d27
Release 2.2.0
abelsiqueira Jan 17, 2023
4464d10
Allow triggering zenodraft manually for when the action is not triggered
abelsiqueira Jan 17, 2023
ace2a60
zenodraft/action updated the file CITATION.cff with the prereserved doi
Jan 17, 2023
f3f1bca
Fix bug related to OpenSLL
abelsiqueira Mar 31, 2023
ba28c53
First attempt to call orcid API
c-martinez Aug 25, 2022
bd7f6bb
Add orcid API values to UI
c-martinez Mar 26, 2023
e20aad4
Addressing feedback from Abel
c-martinez Apr 3, 2023
eb88e13
Add quasar positive feedback
c-martinez Apr 4, 2023
d774bd4
Fix orcid linter issues
c-martinez Apr 12, 2023
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 .babelrc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"plugins": ["@babel/plugin-syntax-dynamic-import"],
"env": {
"test": {
"plugins": ["dynamic-import-node"],
"plugins": ["dynamic-import-node", "istanbul"],
"presets": [
[
"@babel/preset-env",
Expand Down
2 changes: 2 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ module.exports = {
'plugin:vue/vue3-strongly-recommended', // Priority B: Strongly Recommended (Improving Readability)
// 'plugin:vue/vue3-recommended', // Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead)

'plugin:cypress/recommended',

'standard'

],
Expand Down
9 changes: 8 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
# Pull request details

As a contributor I confirm
- [ ] I read and followed the instructions in [CONTRIBUTING.md](CONTRIBUTING.md)
- [ ] The developer documentation is up to date with the changes introduced in this Pull Request
- [ ] Tests are passing
- [ ] All the workflows are passing

## List of related issues or pull requests

Refs: #ISSUE_NUMBER
Refs:
- #ISSUE_NUMBER


## Describe the changes made in this pull request
Expand Down
10 changes: 4 additions & 6 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,15 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
- name: Use Node.js 14
uses: actions/setup-node@v2
- name: Use Node.js 18
uses: actions/setup-node@v3
with:
node-version: '14'
node-version: '18'
cache: 'npm'
- name: Run npm clean-install
run: npm clean-install
- name: Run build
run: npm run build


2 changes: 1 addition & 1 deletion .github/workflows/cffconvert.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out a copy of the repository
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Check whether the citation metadata from CITATION.cff is valid
uses: citation-file-format/[email protected]
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
- name: Use Node.js 14
uses: actions/setup-node@v2
- name: Use Node.js 18
uses: actions/setup-node@v3
with:
node-version: '14'
node-version: '18'
cache: 'npm'
- name: Run npm clean-install
run: npm clean-install
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,21 @@ on:
pull_request:
branches:
- main
release:
workflow_dispatch:

jobs:
preview:
if: github.repository_owner == 'citation-file-format'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
- name: Use Node.js 14
uses: actions/setup-node@v2
- name: Use Node.js 18
uses: actions/setup-node@v3
with:
node-version: '14'
node-version: '18'
cache: 'npm'
- name: Run npm clean-install
run: npm clean-install
Expand Down Expand Up @@ -56,4 +57,3 @@ jobs:
script: |
const { issue: { number: issue_number }, repo: { owner, repo } } = context;
github.issues.createComment({ issue_number, owner, repo, body: 'Once the build has completed, you can preview your PR at this URL: https://cffinit.netlify.app/PR${{ github.event.number }}/' });

8 changes: 4 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
- name: Use Node.js 14
uses: actions/setup-node@v2
- name: Use Node.js 18
uses: actions/setup-node@v3
with:
node-version: '14'
node-version: '18'
cache: 'npm'
- name: Run npm clean-install
run: npm clean-install
Expand Down
27 changes: 20 additions & 7 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,30 @@ jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
- name: Use Node.js 14
uses: actions/setup-node@v2
- name: Use Node.js 18
uses: actions/setup-node@v3
with:
node-version: '14'
node-version: '18'
cache: 'npm'
- name: Run npm clean-install
run: npm clean-install
- name: Run unit tests
run: npm run test:unit:ci


run: npm run test:unit:coverage
- name: Cypress run
uses: cypress-io/github-action@v4
with:
start: npm run dev
wait-on: 'http://localhost:8080/cff-initializer-javascript/#'
- name: Upload Screenshot of Cypress when errors occur
if: failure()
uses: actions/upload-artifact@v3
with:
name: cypress-screenshots
path: cypress/screenshots
- name: Code coverage
uses: codecov/codecov-action@v3
with:
files: ./test/jest/coverage/coverage-final.json,./coverage/coverage-final.json
5 changes: 3 additions & 2 deletions .github/workflows/zenodraft.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ on:
release:
types:
- published
workflow_dispatch:

jobs:
publish:
runs-on: ubuntu-latest
steps:
- name: Checkout the contents of your repository
uses: actions/checkout@v2
uses: actions/checkout@v3
- name: Create a draft snapshot of your repository contents as a new
version in collection 1404735 on Zenodo using metadata
from repository file .zenodo.json
Expand All @@ -21,7 +22,7 @@ jobs:
with:
collection: 1404735
metadata: .zenodo.json
publish: false
publish: true
sandbox: false
upsert-doi: true
upsert-location: identifiers[0]
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,12 @@ yarn-error.log*
*.njsproj
*.sln
node_modules

# Cypress
cypress/downloads
cypress/screenshots
cypress/videos

# Coverage related
coverage
.nyc_output
4 changes: 4 additions & 0 deletions .nycrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"extends": "@istanbuljs/nyc-config-babel",
"extension": [".js", ".ts", ".vue"]
}
9 changes: 7 additions & 2 deletions .zenodo.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@
"affiliation": "Netherlands eScience Center",
"name": "Garcia Gonzalez, Jesus",
"orcid": "0000-0002-2170-3253"
},
{
"affiliation": "Netherlands eScience Center",
"name": "Cushing, Reggie",
"orcid": "0000-0002-5967-7302"
}
],
"description": "Web form to initialize CITATION.cff files.",
Expand All @@ -41,7 +46,7 @@
"license": {
"id": "Apache-2.0"
},
"publication_date": "2022-06-14",
"publication_date": "2023-01-17",
"title": "cffinit",
"version": "2.0.3"
"version": "2.2.0"
}
10 changes: 7 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ authors:
family-names: Garcia Gonzalez
given-names: Jesus
orcid: https://orcid.org/0000-0002-2170-3253
- affiliation: Netherlands eScience Center
family-names: Cushing
given-names: Reggie
orcid: https://orcid.org/0000-0002-5967-7302
cff-version: 1.2.0
date-released: 2022-06-14
date-released: 2023-01-17
identifiers:
- type: doi
value: 10.5281/zenodo.6641931
value: 10.5281/zenodo.7543718
description: >-
This is the identifier used to uniquely identify the version of the
software.
Expand All @@ -46,4 +50,4 @@ license: Apache-2.0
message: If you use this software, please cite it using these metadata.
repository-code: https://github.com/citation-file-format/cff-initializer-javascript
title: cffinit
version: 2.0.3
version: 2.2.0
73 changes: 73 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# 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, 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 [email protected]. 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](https://www.contributor-covenant.org), version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing guidelines

We welcome any kind of contribution to our software, from simple comment or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). Please read and follow our Code of Conduct [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

A contribution can be one of the following cases:

- you have a question;
- you think you may have found a bug (including unexpected behavior);
- you want to make some kind of change to the code base (e.g. to fix a bug, to add a new feature, to update documentation).

The sections below outline the steps in each case.

## You have a question

- use the search functionality [here](https://github.com/citation-file-format/cff-initializer-javascript/issues) to see if someone already filed the same issue;
- if your issue search did not yield any relevant results, make a new issue;

## You think you may have found a bug

- use the search functionality [here](https://github.com/citation-file-format/cff-initializer-javascript/issues) to see if someone already filed the same issue;
- if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue, you may want to include:
- the version of cffinit (bottom right in the app);
- if you are using a development version, the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas) of the commit that is causing your problem;
- some identifying information (name and version number) for dependencies you're using;
- information about the operating system;

## You want to make some kind of change to the code base

- (**important**) announce your plan to the rest of the community *before you start working*. This announcement should be in the form of a (new) issue;
- (**important**) wait until some kind of consensus is reached about your idea being implemented;
- if needed, fork the repository to your own Github profile and create your own feature branch off of the latest main commit. While working on your feature branch, make sure to stay up to date with the main branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/);
- read the [developer documentation](README.dev.md);
- make sure the existing tests still work;
- add your own tests (if necessary);
- update or expand the developer documentation;
- [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the cff-initializer-javascript repository on GitHub;
- create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/);
- verify that the GitHub workflows passed (if they don't, mark the PR as a draft while you fix it);
- don't request reviews, the reviewer will assign them themselves.

If you don't know how to write or run tests or generate documentation, don't let this discourage you; we can help! Ask for help on the relevant issue so we can decide how to proceed.
Loading