Add Contributing.md #140
Add Contributing.md #140
Conversation
🦋 Changeset detectedLatest commit: a383ed4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for codemirror-json-schema ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
thank you @NickTomlin ! this looks like it covers everything, and great points on the follow up! the style guide especially - @imolorhe and I have been collaborating on open source for years so we can operate with a kind of "collective intent", but yes we do need to make it more welcoming and straightforward for new contributors! (and also, i was just too lazy to set up |
|
ah, one thing to add, we need to mention
|
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## [email protected] ### Patch Changes - [#133](#133) [`4fd7cc6`](4fd7cc6) Thanks [@imolorhe](https://github.com/imolorhe)! - Get sub schema using parsed data for additional context - [#137](#137) [`29e2da5`](29e2da5) Thanks [@xdavidwu](https://github.com/xdavidwu)! - Fix description markdown rendering in completion - [#144](#144) [`ef7f336`](ef7f336) Thanks [@imolorhe](https://github.com/imolorhe)! - updated to use fine grained shiki bundle - [#139](#139) [`bfbe613`](bfbe613) Thanks [@NickTomlin](https://github.com/NickTomlin)! - Move non essential packages to devDependencies - [#140](#140) [`bceace2`](bceace2) Thanks [@NickTomlin](https://github.com/NickTomlin)! - Add CONTRIBUTING.md file Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This is a follow-up to #139 (comment) that starts a rough draft of a contributing doc.
I'm still unfamiliar with the project, so please let me know if there's something I missed or anything that could be better!
Additional context
More info about
CONTRIBUTING.mdin the Github docsFuture possibilities
Force / warn about package managers other than
pnpmnpmphas some docs aroundonly-allowthat would warn / force users to usepnpmbut it seems likenpmdoes not honor thepreinstallhook so this will only work foryarnStyle guidelines
I'm not sure if there's a particular coding style that the project wants to follow but having a basic
eslint(that isn't too opinionated 😄) might help. If not, maybe a small section about any guidelines you all have could be useful.