Skip to content
Snippets Groups Projects
Commit 05fec351 authored by Jure's avatar Jure
Browse files

Merge branch 'contributing_docs' into 'master'

docs: add docs contributing docs

See merge request pubsweet/pubsweet!522
parents fd63ca99 b1741ba3
No related branches found
No related tags found
No related merge requests found
......@@ -26,6 +26,10 @@ We maintain `master` of the PubSweet monorepo (a [Lerna](https://lernajs.io/ 'un
- Clone `master` with `git clone git@gitlab.coko.foundation:pubsweet/pubsweet.git`
- Create a new branch and work off that. Please name the branch which sensibly identifies the feature you are working on. You can push the branch to Coko Gitlab at anytime.
# Contributing documentation
The website you are reading, `pubsweet.coko.foundation` is our `react-styleguide` instance. You can start it up from the repository with `yarn styleguide`, and can then edit its contents either in the `ComponentName.md` files found in the components, or in the `docs/content/*.md` files. For example, the content for the FAQ is in `docs/content/faq.md`. As you edit the files, you will get a live preview of your changes. Once a MR is submitted, the styleguide is automatically built and a review deployment should be available. After the MR is merged, our pipeline will update this website.
## Use Conventional Commits
An automated process will reject your commit if it doesn't follow the commit guidelines. All notable changes to the work will be automatically documented in a `CHANGELOG.md` file. See [Conventional Commits](https://conventionalcommits.org/ 'undefined') for commit guidelines.
......
......@@ -7,6 +7,10 @@ module.exports = {
name: 'Introduction',
content: './content/introduction.md',
},
{
name: 'Contributing',
content: './content/contributing.md',
},
{
name: 'Examples of platforms built with PubSweet',
content: './content/examples_of_platforms_built_with_pubsweet.md',
......@@ -112,10 +116,6 @@ module.exports = {
},
],
},
{
name: 'Contributing',
content: './content/contributing.md',
},
{
name: 'Component library',
sections: [
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment