Skip to content

Make CONTRIBUTING.md much shorter. Move long text to docs/contributing.md#7293

Merged
Siedlerchr merged 2 commits into
masterfrom
move-contributing
Jan 8, 2021
Merged

Make CONTRIBUTING.md much shorter. Move long text to docs/contributing.md#7293
Siedlerchr merged 2 commits into
masterfrom
move-contributing

Conversation

@koppor

@koppor koppor commented Jan 4, 2021

Copy link
Copy Markdown
Member

We have https://devdocs.jabref.org as central hub for developer's documentation. Why not also the one to contribute code? Thus, I moved the contents of CONTRIBUTING.md to docs/contributing.md.

After merging, it will nicely render at https://devdocs.jabref.org/contributing.

After merging, the link at https://docs.jabref.org/faqcontributing needs to be updated to https://devdocs.jabref.org/contributing (to avoid users navigating to CONTRIBUTING.md and then to the long text).

  • Change in CHANGELOG.md described (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

@koppor koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jan 4, 2021
@Siedlerchr Siedlerchr merged commit 74da6ec into master Jan 8, 2021
@Siedlerchr Siedlerchr deleted the move-contributing branch January 8, 2021 14:47
Siedlerchr added a commit that referenced this pull request Jan 10, 2021
…dtask

* upstream/master:
  Fixed exception about missing custom css file (#7292)
  Update the templates for opening a new issue (#7321)
  Entitlements file Mac (#7317)
  Make CONTRIBUTING.md much shorter. Move long text to docs/contributing.md (#7293)
  Include Github-optimized screenshot into repository (#7318)
Siedlerchr added a commit that referenced this pull request Jan 10, 2021
* upstream/master: (34 commits)
  Fixed exception about missing custom css file (#7292)
  Update the templates for opening a new issue (#7321)
  Entitlements file Mac (#7317)
  Make CONTRIBUTING.md much shorter. Move long text to docs/contributing.md (#7293)
  Include Github-optimized screenshot into repository (#7318)
  Remove obsolete registry patch file (#7316)
  Fix AUTHORS
  GitBook: [master] one page modified
  Remove broken Sonarqube integration (#7315)
  GitBook: [master] 5 pages and 32 assets modified
  docs: update license year (#7314)
  Add javafx version number + update javafx (#7312)
  Add missing authors
  Adjust zbmath fetcher (#7298)
  Add "acm-siggraph.csl" required by CitationStyle.java
  Added Keyboard shortcuts (clear/set read status) (#7302)
  Add special fields ADR (#7300)
  Overwrite local copies
  Squashed 'buildres/csl/csl-locales/' content from commit ecb8e70233
  Squashed 'buildres/csl/csl-styles/' content from commit 737ffa1
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants