51 lines
2.6 KiB
Markdown
51 lines
2.6 KiB
Markdown
# Contributing to Astro-GhostCMS
|
|
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
|
|
|
|
- Reporting a bug
|
|
- Discussing the current state of the code
|
|
- Submitting a fix
|
|
- Proposing new features
|
|
- Becoming a maintainer
|
|
|
|
## We Develop with Github & Sync our Code to GitLab
|
|
We use github to host code, to track issues and feature requests, as well as accept pull requests. Then All of our Code is Mirrored to GitLab.
|
|
|
|
## We Use Changesets to aid with Development!
|
|
This repo uses [changesets](https://github.com/changesets/changesets) to make releasing updates easier. For you, the contributor, this means you should run `pnpm changeset` when you've got your changes ready.
|
|
|
|
For more details, see this short document on [adding a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md#i-am-in-a-single-package-repository).
|
|
|
|
## We Use Github, So All Code Changes Happen Through Pull Requests and Commits
|
|
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
|
|
|
|
1. Fork the repo and create your branch from `main`.
|
|
2. If you've changed APIs or Added features, update the documentation.
|
|
3. Make sure to test your code in the `Playground`
|
|
4. Issue that pull request!
|
|
|
|
## Any contributions you make will be under the MIT Software License
|
|
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
|
|
|
|
## Report bugs using Github's [issues](https://github.com/MatthiesenXYZ/astro-ghostcms/issues) or [issues@astro-ghostcms.xyz](mailto:issues@astro-ghostcms.xyz)
|
|
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
|
|
|
|
## Write bug reports with detail, background, and sample code
|
|
|
|
**Great Bug Reports** tend to have:
|
|
|
|
- A quick summary and/or background
|
|
- Steps to reproduce
|
|
- Be specific!
|
|
- Give sample code if you can. Or a minimum reproduction using a empty repo, or Gitpod type setup.
|
|
- What you expected would happen
|
|
- What actually happens
|
|
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
|
|
|
|
People *love* thorough bug reports. I'm not even kidding.
|
|
|
|
## License
|
|
By contributing, you agree that your contributions will be licensed under its MIT License.
|
|
|
|
## References
|
|
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)
|