gunghogeoduck/osem-fcy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge ab69d5f6ce into e267adf8b7

Browse source
This commit is contained in:
Lubos Kocman 2026-08-12 10:04:16 -07:00 • committed by GitHub
commit cb4936f2e5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md
View file

@ -91,36 +91,50 @@ sed "s/13042/`id -u`/" docker-compose.override.yml.example > docker-compose.over
1. Build the development environment (only once) 1. Build the development environment (only once)
```bash ```bash
docker-compose build --no-cache --pull docker compose build --no-cache --pull
``` ```
1. Set up the development environment (only once) 1. Set up the development environment (only once)
```bash ```bash
docker-compose run --rm osem bundle exec rake db:bootstrap docker compose run --rm osem bundle install
docker compose run --rm osem bundle exec rake db:bootstrap
``` ```
1. Start the development environment: 1. Start the development environment:
```bash ```bash
docker-compose up --build docker compose up --build
``` ```
1. Check out your OSEM rails app. You can access the app at http://localhost:3000. Whatever you change in your cloned repository will have effect in the development environment. Sign up, the first user will be automatically assigned the admin role. 1. Check out your OSEM rails app. You can access the app at http://localhost:3000. Whatever you change in your cloned repository will have effect in the development environment. Sign up, the first user will be automatically assigned the admin role.
1. Changed something? Run the tests to verify your changes! 1. Changed something? Run the tests to verify your changes!
```bash ```bash
docker-compose run --rm osem bundle exec rspec spec docker compose run --rm osem bundle exec rspec spec
``` ```
1. Issue any standard `rails`/`rake`/`bundler` command 1. Issue any standard `rails`/`rake`/`bundler` command
```bash ```bash
docker-compose run --rm osem bundle exec rake db:version docker compose run --rm osem bundle exec rake db:version
``` ```
1. Or explore the development environment: 1. Or explore the development environment:
```bash ```bash
docker-compose exec osem /bin/bash -l docker compose exec osem /bin/bash -l
``` ```
You might need to remove lock file manually in certain cases, otherwise the app will not start.
Please make sure that osem is running (e.g. with docker compose up --build)
```bash
docker compose exec osem /bin/bash -l
rm /osem/tmp/pids/server.pid
```
1. Want to know more? In our [wiki](https://github.com/openSUSE/osem/wiki) you can find more information about what is possible in our development environment, how we work with each other on github or other topics of interest for OSEM developers. 1. Want to know more? In our [wiki](https://github.com/openSUSE/osem/wiki) you can find more information about what is possible in our development environment, how we work with each other on github or other topics of interest for OSEM developers.
## Note on SELinux
If you experience build issues related to misisng files. This will be likely related to SELinux.
Consider temporarily switching it to the permissive mode to eliminate this possiblity.
## How to contribute translations ## How to contribute translations
Please refer to our [translation guide](https://github.com/openSUSE/osem/wiki/Translation) in the wiki. Please refer to our [translation guide](https://github.com/openSUSE/osem/wiki/Translation) in the wiki.