Improved contributing instructions #130
Conversation
|
|
||
| ### General Considerations | ||
| 1. If there's something you'd like to add, and the issue doesn't already exist, create a new one and assign yourself to it. Wait until we've agreed on a plan of action before beginning your work. |
There was a problem hiding this comment.
I thought telling them they can't start without getting an approval from is too harsh, so I replaced that with more of a guideline than an order.
|
|
||
| ### How Users Get the Starter Template | ||
| ## How to Contribute |
There was a problem hiding this comment.
I pushed this part up, as I think this is what they want to know, how to actually contribute, before reading the details of how we do the versioning (at least that is how it was for me).
I also made steps a bit more concrete / practical, and also mentioned e2e tests and docs.
|
|
||
| We currently have two ways to pull the template: | ||
| 1. the `use this template` button on the [repo homepage](https://github.com/wasp-lang/open-saas) |
There was a problem hiding this comment.
If I am correct we don't allow them to use this template directly from the repo anymore, so I dropped this bullet point.
|
|
||
| **This means, that whenever a user pulls the template via `wasp new -t saas`, they are getting the version present in the most recent commit on `main`.** | ||
|
|
||
| NOTE: When Wasp releases a new major version, we should also make sure to update Open SaaS to work with this new version. In PR that will bring this update, we should also make sure to update the `TAG_NAME` in the GitHub Workflow that does the tagging, to be the template tag used by the newest version of Wasp. |
There was a problem hiding this comment.
Is this correct, this NOTE?
There was a problem hiding this comment.
yep @Martinsos this sounds right
|
|
||
| ## Changes & Contributions | ||
|
|
||
| ### Template Versioning |
There was a problem hiding this comment.
I removed these instructions and instead we just point them directly to CONTRIBUTING.md now. So there is no duplication and it is clear where they need to go.
|
|
||
| Note that we've tried to get as many of the core features of a SaaS app into this template as possible, but there still might be some missing features or functionality. | ||
|
|
||
| We could always use some help tying up loose ends, so consider [contributing](https://github.com/wasp-lang/open-saas/blob/main/CONTRIBUTING.md)! | ||
| We could always use some help tying up loose ends: contributions are welcome! Check out [CONTRIBUTING.md](/CONTRIBUTING.md) for more details. |
There was a problem hiding this comment.
I used this trick with /... to link to the stuff in the GitHub repo directly, without having https://github.com/.... in front, which makes it more robust and simpler.
No description provided.