Skip to content

Commit

Permalink
Added warning to CONTRIBUTING.md to not commit migrations/ dir.
Browse files Browse the repository at this point in the history
  • Loading branch information
Martinsos committed May 22, 2024
1 parent d862a5d commit 69b0ddf
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This helps, especially with the more complex issues, as it allows us to discuss
## How to Contribute
1. Make sure you understand the basics of how open-saas works (check out [docs](https://docs.opensaas.sh)).
2. Check out this repo (`main` branch) and make sure you are able to get the app in `app/` running (to set it up, follow the same steps as for running a new open-saas app, as explained in the open-saas docs).
3. Create a new git branch for your work (aka feature branch) and do your changes on it.
3. Create a new git branch for your work (aka feature branch) and do your changes on it. NOTE: don't commit `app/migrations/` dir.
4. Update e2e tests in [e2e-tests](/e2e-tests/) if needed and make sure they are passing.
5. Create a pull request (towards `main` as a base branch).
6. If docs (also) need updating, check out the `deployed-version` branch, make your own feature branch from it, make changes in [blog/src/content/docs](/blog/src/content/docs/), and submit another PR with those changes (towards `deployed-version` as a base branch).
Expand Down Expand Up @@ -41,3 +41,10 @@ The default, clean template that users get when cloning the starter lives on `ma
If you want to make changes to the default starter template, base feature branches and Pull Requests off of `main`.
If you want to make changes to the OpenSaaS.sh site or it's Documentation, base feature branches and Pull Requests off of `deployed-version`.

### `app/migrations/` dir

User's don't benefit from template coming with `migrations` dir, so we want to keep the template clean for them and not include it.
Still, it will get generated for us when developing the template.
We don't want to add it to template's .gitignore because it shouldn't be gitignored for users of the template.
So for now we are just careful not to commit it during development, till we put some effort in automatically preventing that from happening.

0 comments on commit 69b0ddf

Please sign in to comment.