|
3 | 3 | Thank you for your interest in contributing to CC Open Source! This document is
|
4 | 4 | a set of guidelines to help you contribute to this project.
|
5 | 5 |
|
| 6 | + |
6 | 7 | ## Code of Conduct
|
7 | 8 |
|
8 | 9 | By participating in this project, you are expected to uphold our [Code of
|
9 | 10 | Conduct][code_of_conduct].
|
10 | 11 |
|
11 |
| -[code_of_conduct]:https://opensource.creativecommons.org/community/code-of-conduct/ |
| 12 | +[code_of_conduct]: https://opensource.creativecommons.org/community/code-of-conduct/ |
| 13 | + |
12 | 14 |
|
13 | 15 | ## Project Documentation
|
14 | 16 |
|
15 |
| -The `README` in the root of the repository should contain or link to |
16 |
| -project documentation. If you cannot find the documentation you're |
17 |
| -looking for, please file a GitHub issue with details of what |
18 |
| -you'd like to see documented. |
| 17 | +The `README` in the root of the repository should contain or link to project |
| 18 | +documentation. If you cannot find the documentation you're looking for, please |
| 19 | +file a GitHub issue with details of what you'd like to see documented. |
| 20 | + |
19 | 21 |
|
20 | 22 | ## How to Contribute
|
21 | 23 |
|
22 | 24 | Please follow the processes in our general [Contributing Code][contributing]
|
23 | 25 | guidelines on the Creative Common Open Source website.
|
24 | 26 |
|
25 |
| -[contributing]:https://opensource.creativecommons.org/contributing-code/ |
| 27 | +[contributing]: https://opensource.creativecommons.org/contributing-code/ |
| 28 | + |
26 | 29 |
|
27 | 30 | ## Questions or Thoughts?
|
28 | 31 |
|
29 | 32 | Talk to us on [one of our community forums][community].
|
30 | 33 |
|
31 |
| -[community]:https://opensource.creativecommons.org/community/ |
| 34 | +[community]: https://opensource.creativecommons.org/community/ |
| 35 | + |
32 | 36 |
|
33 | 37 | ## Development
|
34 | 38 |
|
35 | 39 | The following tools are recommended when setting up a development environment.
|
36 | 40 |
|
37 | 41 | - Docker / docker-compose
|
38 | 42 |
|
| 43 | + |
39 | 44 | ### Setting environment variables
|
40 | 45 |
|
41 | 46 | Copy the file `/development/.env.example` to `/development/.env` and change the variables to desired values (or leave as they are.)
|
42 | 47 |
|
| 48 | + |
43 | 49 | ### Running the development server
|
44 | 50 |
|
45 | 51 | Once you have installed the dependencies and configured the environment variables, run the development server with the following command from within the `/development/` folder:
|
46 | 52 |
|
47 |
| - |
48 | 53 | ```sh
|
49 | 54 | docker-compose up
|
50 |
| -``` |
| 55 | +``` |
0 commit comments