dnrops
/
datastar
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve wording

This commit is contained in:
Ben Croker 2025-02-04 12:25:06 -06:00
parent b00c6d160e
commit 0975e24224
No known key found for this signature in database
GPG Key ID: 09D799816F1CF332
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -12,13 +12,19 @@ Anything outside of this scope may not be accepted. If you have a need for a fea
Before submitting bug reports and feature requests, please search the [open issues](https://github.com/starfederation/datastar/issues) and the _#help_ channel in the [Discord server](https://discord.gg/bnRNgZjgPh) to see if it has already been addressed. When submitting a [new issue](https://github.com/starfederation/datastar/issues/new), please use a descriptive title and include a clear description and as much relevant information as possible.
## Pull Requests
Always open an issue to discuss your idea _before_ submitting a pull request. Pull requests must have a descriptive title and clearly describe the problem and solution. If the pull request adds or changes behaviour, documentation and examples should be updated accordingly.
## Documentation
Datastar’s documentation is written in markdown files that live in [this folder](https://github.com/starfederation/datastar/tree/develop/site/static/md). Improvements to them can be submitted via pull requests.
## SDKs
SDKs must follow the [Architecture Decision Record](https://github.com/starfederation/datastar/blob/develop/sdk/README.md) document. Each newly contributed SDK should also include the following:
SDKs must follow the [Architecture Decision Record](https://github.com/starfederation/datastar/blob/develop/sdk/README.md) document.
Pull requests for new SDKs should include the following:
- A README file that explains how to use the SDK.
- An entry in the [SDKs reference guide](https://github.com/starfederation/datastar/blob/develop/site/static/md/reference/sdks.md).
@ -27,10 +33,6 @@ SDKs must follow the [Architecture Decision Record](https://github.com/starfeder
- Sample [code snippets](https://github.com/starfederation/datastar/tree/develop/site/static/code_snippets) in the language of your SDK.
- An implementation of each of the [examples](https://github.com/starfederation/datastar/tree/develop/examples).
## Pull Requests
Always open an issue to discuss your idea _before_ submitting a pull request. Pull requests must have a descriptive title and clearly describe the problem and solution. If the pull request adds or changes behaviour, documentation and examples should be updated accordingly.
## Building
Datastar comes with instructions for building, either manually or via Docker. Read the [Building Guidelines »](BUILDING.md)