Skip to content

Issue 79 contribution guidelines #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing to Documentation

Thanks so much for reading these guidelines. We welcome contributions to our documentation.

For writing and style guidelines we follow the best practices for Github Docs outlined here https://docs.github.com/en/contributing/writing-for-github-docs/best-practices-for-github-docs.

## Purpose

This documentation aims to:
* provide detailed information about the structure of the software
* guidance on deployment
* detailed description of features
* guidance on configuration

## Audience

These documents are written for developers and site-administrators. These documents are desgined to include technical details that will be understood by people with previous programming and DevOps experience.

To contribute or read information aimed at a non-technical audience please see our (user-documentation)[https://github.com/SciCatProject/user-documentation].

## Submission

To make changes to the documentation please make a fork of this repository. When you have finished your contribution please raise a pull request into the `master` branch of the documentation. Your contribution will be reviewed before it is merged.

## Out of Scope
The documentation describes the features of the frontend and backend of the SciCat software at a technical level. User facing documentation is outside the scope of this documentation and should be submitted to: (user-documentation)[https://github.com/SciCatProject/user-documentation]

Site specific documentation should not be included here, unless it is generalised as an example.



2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ npm run start
## Publishing the documentation

The [website](https://scicatproject.github.io/documentation) will be automatically
rebuilt after each change to the `master` branch by a github action.
rebuilt after each change to the `master` branch by a github action.