Revised README.md #4974

kydojo · 2019-05-16T07:04:49Z

Revised the Contributing section of the README.md doc to be more welcoming to new and/or first-time FOSS contributors.

Change in CHANGELOG.md described
Tests created for changes
Manually tested changed features in running JabRef
Screenshots added in PR description (for bigger UI changes)
Ensured that the git commit message is a good one
Check documentation status (Issue created for outdated help page at help.jabref.org?)

Updated the Contributing section of the README.md to be more welcoming to new FOSS contributors. Reordered the section a bit. Added bullet points to break up the information. Included inline links to guides to forking a repo and making a PR. Also, linked to current issues with the "good first issue" label to help new users.

kydojo · 2019-05-16T07:07:20Z

This is my first time contributing to a project. Please let me know if I needed to do something differently and, if so, how I would go about it. Thanks!

tobiasdiez

Welcome to JabRef and thanks for your PR. LGTM

Siedlerchr · 2019-05-16T14:47:22Z

Welcome to JabRef and thanks for your contribution!
For your next PR it is better if you create a new branch first.

kydojo · 2019-05-16T15:27:56Z

@Siedlerchr Sorry about that; will do. Thanks for the feedback!

* upstream/master: Revised README.md (#4974) Switch Jsoup's StringUtil for JabRef's StringUtil (#4970) Remove UI ThreadList for maintable as it prevents sorting in maintable (#4964) fix map collision (#4962)

* upstream/master: Fix downloading pdf produces html as extension (#4965) Too big error message #4827 (#4966) Reformat Understanding the basics section of CONTRIBUTING.md (#4978) Revised README.md (#4974) Switch Jsoup's StringUtil for JabRef's StringUtil (#4970)

26265bf Create pacific-science.csl (JabRef#5020) e6ff62e Update pravnik.csl & iso690-full-note-cs.csl (JabRef#5019) 8ab9362 Create turabian-9-author-date (JabRef#4796) 28c7021 Update west-european-politics.csl (JabRef#4900) 6d06e5e Create american-physical-society-et-al (JabRef#4974) 7472744 Create farmeconomia.csl (JabRef#5017) bd916df Create amerindia.csl (JabRef#5011) 28d176d Create law-technology-and-humans-journal-style.csl (JabRef#5015) a998aa5 Create kerala-journal-of-ophthalmology.csl (JabRef#5014) 8662257 Update journal-of-australian-strength-and-conditioning.csl (JabRef#5010) e28f06f Create clinical-management-issues.csl (JabRef#5008) abb92fb Create institut-francais-darcheologie-orientale-en.csl (JabRef#4870) f931c78 Update institut-francais-darcheologie-orientale.csl (JabRef#4869) 9d604ca Update journal-of-foraminiferal-research.csl 1191d07 add Journal of Foraminiferal Research (JabRef#5007) 0903e9d Update molecular-therapy.csl (JabRef#5009) 316d6c7 Update journal-of-alzheimers-disease.csl (JabRef#5006) 868a7ed Create journal-of-soil-science-and-plant-nutrition (JabRef#5005) 875ef81 Create universitat-bern-institut-fur-sozialanthropologie.csl (JabRef#4998) 1194b81 Create journal-de-la-societe-des-americanistes.csl (JabRef#4995) 1d2a472 Update international-energy-agency-organisation-for-economic-co-operation-and-development.csl (JabRef#4999) 02a26ef Update iso690-author-date-cs.csl (JabRef#5003) 165592c Create european-journal-of-entomology.csl (JabRef#5001) 4d587ca Create european-journal-of-anaesthesiology.csl (JabRef#5002) git-subtree-dir: src/main/resources/csl-styles git-subtree-split: 26265bf

26265bf Create pacific-science.csl (#5020) e6ff62e Update pravnik.csl & iso690-full-note-cs.csl (#5019) 8ab9362 Create turabian-9-author-date (#4796) 28c7021 Update west-european-politics.csl (#4900) 6d06e5e Create american-physical-society-et-al (#4974) 7472744 Create farmeconomia.csl (#5017) bd916df Create amerindia.csl (#5011) 28d176d Create law-technology-and-humans-journal-style.csl (#5015) a998aa5 Create kerala-journal-of-ophthalmology.csl (#5014) 8662257 Update journal-of-australian-strength-and-conditioning.csl (#5010) e28f06f Create clinical-management-issues.csl (#5008) abb92fb Create institut-francais-darcheologie-orientale-en.csl (#4870) f931c78 Update institut-francais-darcheologie-orientale.csl (#4869) 9d604ca Update journal-of-foraminiferal-research.csl 1191d07 add Journal of Foraminiferal Research (#5007) 0903e9d Update molecular-therapy.csl (#5009) 316d6c7 Update journal-of-alzheimers-disease.csl (#5006) 868a7ed Create journal-of-soil-science-and-plant-nutrition (#5005) 875ef81 Create universitat-bern-institut-fur-sozialanthropologie.csl (#4998) 1194b81 Create journal-de-la-societe-des-americanistes.csl (#4995) 1d2a472 Update international-energy-agency-organisation-for-economic-co-operation-and-development.csl (#4999) 02a26ef Update iso690-author-date-cs.csl (#5003) 165592c Create european-journal-of-entomology.csl (#5001) 4d587ca Create european-journal-of-anaesthesiology.csl (#5002) git-subtree-dir: src/main/resources/csl-styles git-subtree-split: 26265bf

26265bf Create pacific-science.csl (JabRef#5020) e6ff62e Update pravnik.csl & iso690-full-note-cs.csl (JabRef#5019) 8ab9362 Create turabian-9-author-date (JabRef#4796) 28c7021 Update west-european-politics.csl (JabRef#4900) 6d06e5e Create american-physical-society-et-al (JabRef#4974) 7472744 Create farmeconomia.csl (JabRef#5017) bd916df Create amerindia.csl (JabRef#5011) 28d176d Create law-technology-and-humans-journal-style.csl (JabRef#5015) a998aa5 Create kerala-journal-of-ophthalmology.csl (JabRef#5014) 8662257 Update journal-of-australian-strength-and-conditioning.csl (JabRef#5010) e28f06f Create clinical-management-issues.csl (JabRef#5008) abb92fb Create institut-francais-darcheologie-orientale-en.csl (JabRef#4870) f931c78 Update institut-francais-darcheologie-orientale.csl (JabRef#4869) 9d604ca Update journal-of-foraminiferal-research.csl 1191d07 add Journal of Foraminiferal Research (JabRef#5007) 0903e9d Update molecular-therapy.csl (JabRef#5009) 316d6c7 Update journal-of-alzheimers-disease.csl (JabRef#5006) 868a7ed Create journal-of-soil-science-and-plant-nutrition (JabRef#5005) 875ef81 Create universitat-bern-institut-fur-sozialanthropologie.csl (JabRef#4998) 1194b81 Create journal-de-la-societe-des-americanistes.csl (JabRef#4995) 1d2a472 Update international-energy-agency-organisation-for-economic-co-operation-and-development.csl (JabRef#4999) 02a26ef Update iso690-author-date-cs.csl (JabRef#5003) 165592c Create european-journal-of-entomology.csl (JabRef#5001) 4d587ca Create european-journal-of-anaesthesiology.csl (JabRef#5002) git-subtree-dir: src/main/resources/csl-styles git-subtree-split: 26265bf

kydojo added 2 commits May 15, 2019 16:59

Update README.md

8c5f79f

kydojo marked this pull request as ready for review May 16, 2019 07:05

Siedlerchr added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label May 16, 2019

tobiasdiez approved these changes May 16, 2019

View reviewed changes

Siedlerchr merged commit 89d0f30 into JabRef:master May 16, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revised README.md #4974

Revised README.md #4974

kydojo commented May 16, 2019 •

edited

Loading

kydojo commented May 16, 2019

tobiasdiez left a comment

Siedlerchr commented May 16, 2019

kydojo commented May 16, 2019

Revised README.md #4974

Revised README.md #4974

Conversation

kydojo commented May 16, 2019 • edited Loading

kydojo commented May 16, 2019

tobiasdiez left a comment

Choose a reason for hiding this comment

Siedlerchr commented May 16, 2019

kydojo commented May 16, 2019

kydojo commented May 16, 2019 •

edited

Loading