You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,32 +12,30 @@ The sections below outline the steps in each case.
12
12
13
13
## You have a question
14
14
15
-
16
15
- use the search functionality [here](https://github.com/citation-file-format/cff-initializer-javascript/issues) to see if someone already filed the same issue;
17
16
- if your issue search did not yield any relevant results, make a new issue;
18
-
- apply the "Question" label; apply other labels when relevant.
19
17
20
18
## You think you may have found a bug
21
19
22
-
23
20
- use the search functionality [here](https://github.com/citation-file-format/cff-initializer-javascript/issues) to see if someone already filed the same issue;
24
21
- 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:
25
-
- the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas) of the commit that is causing your problem;
22
+
- the version of cffinit (bottom right in the app);
23
+
- 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;
26
24
- some identifying information (name and version number) for dependencies you're using;
27
25
- information about the operating system;
28
-
- apply relevant labels to the newly created issue.
29
26
30
27
## You want to make some kind of change to the code base
31
28
32
-
33
29
- (**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;
34
-
- (**important**) wait until some kind of consensus is reached about your idea being a good idea;
35
-
- if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master 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/);
36
-
-make sure the existing unit tests still work by running ``npm run test:unit:ci``;
37
-
- make sure all the workflows (Github Action) pass;
30
+
- (**important**) wait until some kind of consensus is reached about your idea being implemented;
31
+
- 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/);
32
+
-read the [developer documentation](README.dev.md);
33
+
- make sure the existing tests still work;
38
34
- add your own tests (if necessary);
39
35
- update or expand the developer documentation;
40
36
-[push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the cff-initializer-javascript repository on GitHub;
41
-
- create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
37
+
- create the pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/);
38
+
- verify that the GitHub workflows passed (if they don't, mark the PR as a draft while you fix it);
39
+
- don't request reviews, the reviewer will assign them themselves.
42
40
43
-
In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.
41
+
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.
# cffinit: a web application to create CITATION.cff files
12
8
13
9
## What cffinit can do for you?
10
+
14
11
When you made some software and you want to include instructions on how to cite it, CITATION.cff files are the answer. However, sometimes it's tricky to ensure you write valid CFF. This tool helps mitigate that problem by generating the CFF text using a web form with form validation and user feedback.
15
12
16
13
## Information for users
14
+
17
15
- Check out the **live version** at <https://citation-file-format.github.io/cff-initializer-javascript/>.
18
16
- For the rationale behind CITATION.cff files, you can read more here:
0 commit comments