You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/docs.md
+40-1Lines changed: 40 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -536,10 +536,49 @@ Take a look at the following paper for middleware- and deployment-level consider
536
536
Contributions to this project are welcome. Some advices:
537
537
538
538
- As we use [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), use `feature-xxx` branches.
539
-
- We recommend *forking* the project, developing your stuff, then contributing back via **pull request** directly from the Web interface.
539
+
- We recommend *forking* the project, developing your stuff, then contributing back via [pull requests (PRs)](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) directly from the Web interface.
540
540
- Stay in sync with the `develop` branch: pull often from `develop`, so that you don't diverge too much from the main development line.
541
541
- Avoid introducing technical debt. In any case, merge requests will be reviewed before merge.
542
542
543
+
## Contributing process
544
+
545
+
Follow these steps to contribute.
546
+
547
+
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [official ScaFi repository](https://github.com/scafi/scafi).
2. Open your project with your favourite IDE, e.g., IntelliJ Idea Community Edition (note: it needs the Scala plugin installed)
556
+
- Open *as sbt project*
557
+
3. Determine *what* your contribution will focus on. For instance, look at [open issues](https://github.com/scafi/scafi/issues).
558
+
4. Develop.
559
+
- As we use [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), use `feature-xxx` branches.
560
+
5. Merge your contribution.
561
+
- From your fork, open a [pull request (PR)](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
562
+
- Wait for the project maintainers to perform a series of checks and merge your branch into the official repository.
563
+
6. Congratulations! Go back to step 3.
564
+
565
+
## Building the project
566
+
567
+
Once you have cloned your ScaFi repository, you can build the project using [sbt](https://www.scala-sbt.org/).
568
+
569
+
You can run tests:
570
+
571
+
```
572
+
sbt test
573
+
```
574
+
575
+
Generate the docs:
576
+
577
+
```
578
+
sbt doc
579
+
```
580
+
581
+
543
582
# Something missing?
544
583
545
584
- If what is missing is of general interest, please [open an Issue in the scafi.github.io repository](https://github.com/scafi/scafi.github.io/issues).
0 commit comments