Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# Contributing to opensilex-docker-compose
Thank you for your interest in contributing to opensilex-docker-compose! We appreciate all contributions, whether they're code improvements, documentation updates, bug reports, feature requests, or anything else. Here's how you can help:
## Guidelines
### Questions Before Contributing
If you have a question about the project, consider opening an issue first to discuss it. This ensures that others can weigh in and provides a centralized place for discussion.
### Ground Rules
- Be welcoming to newcomers and encourage diverse points of view and experiences.
- Keep discussions constructive and positive.
- Communicate openly and honestly.
### Your First Contribution
Unsure where to begin? You can start by looking through the `Issues` tab to find tasks labeled as `good first issue`.
### Reporting Bugs
Report bugs by opening an issue with ``bug template``. Please provide details like the error message, environment, and steps to reproduce the problem.
### Suggesting Enhancements
Enhancement suggestions are tracked as GitLab issues. Create an issue to propose a new feature or improvement.
### Merge Request Process
1. Fork the Project
2. Create a branch (`git checkout -b branch-name`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin branch-name`)
5. Open a Merge Request
#### Note: Always write a clear log message for your commits. One-line messages are fine for small changes, but larger changes should look like this:
```
Short (50 chars or less) summary of changes
More detailed explanatory text, if necessary. Wrap it to about 72 characters or so.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Explain the problem the change addresses and why it's needed
- Explain the change you've made
- Mention any dependencies you've changed or added
- Explain users of older environments or database schema changes
- Explain places you believe the code will affect
- Explain other effects of this MR
## Setup
Ensure you have Docker and Docker Compose installed on your machine. Refer to the official Docker documentation for installation instructions.
### Local Setup
Follow the setup instructions in the [README.md](README.md) to get the project running locally.
### Making Changes
- Create a named branch for your changes (`git checkout -b my-feature-branch`)
- Make commits of logical units of work; no half-done work.
- Use a descriptive commit message.
```sh
git commit -m "Adds feature X"
```
### Building and Testing
After making changes, ensure your code runs successfully with
```bash
docker compose --env-file opensilex.env build --build-arg UID=$(id -u) --build-arg GID=$(id -g)
docker compose --env-file opensilex.env up start_opensilex_stack -d
```
and passes any existing tests.
## Submitting Changes
Open a Merge Request with a clear `title` and `description`. Explain what you did and why.
## Our Standards
- **Have fun!** 🎉
```
Remember, the goal of the project is to make it easy for anyone to contribute. Let's keep things friendly and professional!
---
Feel free to modify this template to fit your project's specifics, such as specific setup instructions, testing frameworks, or additional guidelines you'd like contributors to follow.
---
## Additional Notes
Contributions are what make open-source projects thrive. Thank you for being interested in contributing to opensilex-docker-compose!
## Guide to Contributing
To contribute to opensilex-docker-compose, follow these steps:
### Step 1: Fork the Project
Fork this repository to your GitLab account.
### Step 2: Clone the Repository
Clone your forked repository to your local machine:
```sh
git clone https://forgemia.inra.fr/OpenSILEX/opensilex-docker-compose.git
cd opensilex-docker-compose
```
### Step 3: Make Changes
Make your changes in a new git branch:
```sh
git checkout -b my-feature-branch
```
### Step 4: Build and Test Locally
Ensure your changes don't break the build. If there are tests, run them:
```bash
docker compose --env-file opensilex.env build --build-arg UID=$(id -u) --build-arg GID=$(id -g)
```
### Step 5: Commit Changes
Commit your changes:
```sh
git commit -m "Your detailed description of your changes."
```
### Step 6: Push Changes
Push your changes to GitLab:
```sh
git push origin my-feature-branch
```
### Step 7: Open a Merge Request
Create a merge request against the main branch.
### Our Standards
- **Do not** rebase your branch off `main`.
- **Include screenshots of the UI and save them in the GitLab repository.
### Additional Resources
- Docker Documentation
- Docker Best Practices