Skip to content

Commit

Permalink
add CONTRIBUTION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
spaghettiwews committed Apr 26, 2019
1 parent 68084f9 commit 23a21f5
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contribute to the Paynow API & SDK docs

## Create a fork

It’s best to make changes to the docs on your local machine to check for consistent visual styling. Make sure you’ve created a fork of `paynow/docs` on GitHub and cloned the repository locally on your machine.

You can then create a separate branch for your additions. Be sure to choose a descriptive branch name that best fits the type of content. The following is an example of a branch name you might use for updating code examples in the Python SDK doc page:

```bash
$ git checkout -b update-python-code-examples
```

## Markup

1. All `docs/` markdown files need to include a header section at the top of the file. The header contains metadata used to generate the page slug, title, and sidebar label among other things. You can read more about it [here][docusaurus_markdown]
1. The only **H1** tag that is the title of the page will be generated from header `title` variable so there's no need to manually include one.
1. Main page subsections should use **H2** tags and next-level subsections to those should use **H3** tags. These **H2** and **H3** tags will be used to generate section navigation links in the right sidebar.

## Code blocks
Use the typical triple-back-tick markdown syntax (```) is used.

To add language syntax highlighting, append the language to the opening triple-back-tick as seen here:

<pre>
<code>```bash
$ cd ~/Projects/docs/website && npm install && npm start
```</code>
</pre>

Your options for languages are `sh`, `bash`, `cs`, `csharp`, `python`, `java`, `nodejs`, `php`, `gradle`, `xml`.

<!-- Links -->
[docusaurus_markdown]: https://docusaurus.io/docs/en/doc-markdown#documents
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ $ git clone https://github.com/paynow/docs.git
```

#### Install and run

```bash
$ cd docs/website
$ npm install #to install all required dependencies
Expand All @@ -37,11 +38,14 @@ $ npm start #to start the development server & watcher

## Contributing

We welcome contributions to this and the SDKs repositories of any kind including documentation, suggestions, bug reports, pull requests etc. Do check out our [contribution guide][contribution_guide]. We would love to hear from you.

## Building and Deploying

Changes that are merged into `master` branch are automatically built and deployed by CI.


<!-- LINKS -->
[source_url]: https://github.com/paynow/docs.git
[docusaurus]: https://docusaurus.io
[docusaurus]: https://docusaurus.io
[contribution_guide]: https://github.com/paynow/docs/blob/master/CONTRIBUTING.md

0 comments on commit 23a21f5

Please sign in to comment.