Skip to content

Commit ac6daad

Browse files
docs: simplify contributing guidelines
1 parent 43c0593 commit ac6daad

File tree

1 file changed

+2
-93
lines changed

1 file changed

+2
-93
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -30,100 +30,9 @@ If you encounter any bugs or issues, feel free to report them on our [GitHub iss
3030
- If reporting a bug, confirm that you are using the latest version of Optiland.
3131
- If requesting a feature, consider explaining how it benefits the project.
3232

33-
**Please consider using one of the following templates based on your issue type:**
34-
35-
---
36-
37-
## 🐛 Bug Report
38-
39-
```markdown
40-
### 🐛 Bug Report
41-
**Describe the bug**
42-
A clear and concise description of what the bug is.
43-
44-
**Steps to Reproduce**
45-
1. Define lens system '...'
46-
2. Try to run command '...' with argument '...'
47-
3. Observe the behavior
48-
49-
**Expected Behavior**
50-
Describe what you expected to happen.
51-
52-
**Actual Behavior**
53-
Describe what actually happened.
54-
55-
**Screenshots (if applicable)**
56-
If applicable, add screenshots to help explain the issue.
57-
58-
**Environment**
59-
- Optiland Version: `X.X.X`
60-
- Python Version: `X.X`
61-
- OS: `[Windows/Linux/macOS]`
62-
- Additional Info:
63-
64-
**Additional Context**
65-
Any other relevant information? Error messages, etc.
66-
```
67-
68-
## ✨ Feature Request
69-
70-
```markdown
71-
### ✨ Feature Request
72-
**Is your feature request related to a problem? Please describe.**
73-
A clear and concise description of the problem.
74-
75-
**Describe the solution you'd like**
76-
A clear and concise description of what you want to happen.
77-
78-
**Describe alternatives you've considered**
79-
Any alternative solutions or features you've considered.
80-
81-
**Additional Context**
82-
Any extra details? Screenshots, diagrams, or links to related resources?
83-
```
84-
85-
## ❓ Question or Discussion
86-
87-
```markdown
88-
### ❓ Question/Discussion
89-
**What is your question?**
90-
Explain what you need help with.
91-
92-
**Relevant Context**
93-
Any background information that might help answer your question.
94-
```
95-
96-
## 📚 Documentation Request
97-
98-
```markdown
99-
### 📚 Documentation Request
100-
**What is unclear or missing?**
101-
Describe what part of the documentation needs improvement or correction.
102-
103-
**Suggested Improvements**
104-
Any suggestions for how the documentation could be improved?
105-
```
106-
107-
## 🚀 Contribution Proposal
108-
109-
```markdown
110-
### 🚀 Contribution Proposal
111-
**What are you proposing to work on?**
112-
Briefly describe your idea.
113-
114-
**Why is this valuable?**
115-
Explain why this contribution would benefit Optiland.
116-
117-
**Plan of Action**
118-
A rough outline of what needs to be done.
119-
120-
**Additional Notes**
121-
Any dependencies, challenges, or discussions needed before starting?
122-
```
123-
124-
## 📌 Additional Notes
33+
### Additional Notes
12534
- If you’re submitting a bug report, consider adding a minimal reproducible example.
12635
- If you're unsure where your issue fits, feel free to ask!
12736
- Please be respectful and constructive when discussing issues.
12837

129-
We appreciate your contributions and look forward to collaborating! 🚀
38+
We appreciate your contributions and look forward to collaborating!

0 commit comments

Comments
 (0)