Skip to content

Commit c23f7d8

Browse files
committed
Contributing + building
1 parent c2d15b4 commit c23f7d8

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

pages/docs.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -536,10 +536,49 @@ Take a look at the following paper for middleware- and deployment-level consider
536536
Contributions to this project are welcome. Some advices:
537537

538538
- 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.
540540
- Stay in sync with the `develop` branch: pull often from `develop`, so that you don't diverge too much from the main development line.
541541
- Avoid introducing technical debt. In any case, merge requests will be reviewed before merge.
542542

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).
548+
2. Prepare your environment.
549+
1. Clone your own fork.
550+
```
551+
$ git clone [email protected]:<username>/scafi.git
552+
$ cd scafi
553+
$ git checkout -b develop origin/develop
554+
```
555+
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+
543582
# Something missing?
544583
545584
- 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

Comments
 (0)