799c7e6936
Co-authored-by: Denys Konovalov <kontakt@denyskon.de> Co-authored-by: Mathieu COSYNS <64072917+Mathieu-COSYNS@users.noreply.github.com>
36 lines
2.7 KiB
Plaintext
36 lines
2.7 KiB
Plaintext
---
|
|
group: Contributing
|
|
title: Contributor Guide
|
|
weight: 20
|
|
---
|
|
|
|
We are hoping that Static CMS will do for the [Jamstack](https://www.jamstack.org) what WordPress did for dynamic sites back in the day. We know we cannot do that without building a thriving community of contributors and users, and we would love to have you join us.
|
|
|
|
## Getting started with contributing
|
|
Being a developer is not a requirement for contributing to Static CMS, you only need the desire, a web browser, and a [GitHub account](https://github.com/join). The GitHub repo has a step-by-step [guide](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md) to get started with the code.
|
|
|
|
## The basics of the Static CMS docs
|
|
The documentation for Static CMS is written in [Markdown](http://daringfireball.net/projects/markdown/) (a good cheatsheet on Markdown is [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)), with the source residing on [GitHub](https://github.com/StaticJsCMS/static-cms) in the `/packages/docs/content/docs` folder.
|
|
|
|
The GitHub website allows you to submit issues, work with files, search for content, and browse changes that have been submitted in the past and those that are being submitted now (aka Pull Requests).
|
|
|
|
## Style guidelines
|
|
A [style guide](/docs/writing-style-guide/) is available to help provide context around grammar, code styling, syntax, etc.
|
|
|
|
## Filing issues
|
|
If you have a GitHub account, you can file an [issue](https://github.com/StaticJsCMS/static-cms/issues) (aka bug report) against the Static CMS docs. Even if you are not able to, or do not know how to, fix the issue (see [Improve existing content](#improve-existing-content)), it helps to start the conversation.
|
|
|
|
When filing an issue, it is important to remember the [Code of Conduct](https://github.com/StaticJsCMS/static-cms/blob/main/CODE_OF_CONDUCT.md).
|
|
|
|
## Improve existing content
|
|
If you are able to offer up a change to existing content, it is welcome. Once you have forked the repo, and changed the content, you would file a pull request (PR). The repo [Contributing file](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md) lays out the correct format for PRs.
|
|
|
|
## Other places to get involved
|
|
Here are some links with more information about getting involved:
|
|
|
|
* [Setup instructions and Contribution Guidelines](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md)
|
|
* [Join our Community Chat](/chat)
|
|
* [Code of Conduct](https://github.com/StaticJsCMS/static-cms/blob/main/CODE_OF_CONDUCT.md)
|
|
* [Project Milestones](https://github.com/StaticJsCMS/static-cms/milestones)
|
|
* [Good First Issues](https://github.com/StaticJsCMS/static-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22+-label%3Aclaimed)
|