Pq234 commited on
Commit
6fd3f3c
·
verified ·
1 Parent(s): d288030

Delete CONTRIBUTING.md

Browse files
Files changed (1) hide show
  1. CONTRIBUTING.md +0 -196
CONTRIBUTING.md DELETED
@@ -1,196 +0,0 @@
1
- # Contributing to Research Article Template
2
-
3
- Thank you for your interest in contributing to the Research Article Template! This document provides guidelines and information for contributors.
4
-
5
- ## 🤝 How to Contribute
6
-
7
- ### Reporting Issues
8
-
9
- Before creating an issue, please:
10
- 1. **Search existing issues** to avoid duplicates
11
- 2. **Use the issue template** when available
12
- 3. **Provide detailed information**:
13
- - Clear description of the problem
14
- - Steps to reproduce
15
- - Expected vs actual behavior
16
- - Environment details (OS, Node.js version, browser)
17
- - Screenshots if applicable
18
-
19
- ### Suggesting Features
20
-
21
- We welcome feature suggestions! Please:
22
- 1. **Check existing discussions** first
23
- 2. **Describe the use case** clearly
24
- 3. **Explain the benefits** for the community
25
- 4. **Consider implementation complexity**
26
-
27
- ### Code Contributions
28
-
29
- #### Getting Started
30
-
31
- 1. **Fork the repository** on Hugging Face
32
- 2. **Clone your fork**:
33
- ```bash
34
- git clone git@hf.co:spaces/<your-username>/research-article-template
35
- cd research-article-template
36
- ```
37
- 3. **Install dependencies**:
38
- ```bash
39
- cd app
40
- npm install
41
- ```
42
- 4. **Create a feature branch**:
43
- ```bash
44
- git checkout -b feature/your-feature-name
45
- ```
46
-
47
- #### Development Workflow
48
-
49
- 1. **Make your changes** following our coding standards
50
- 2. **Test thoroughly**:
51
- ```bash
52
- npm run dev # Test locally
53
- npm run build # Ensure build works
54
- ```
55
- 3. **Update documentation** if needed
56
- 4. **Commit with clear messages**:
57
- ```bash
58
- git commit -m "feat: add new component for interactive charts"
59
- ```
60
-
61
- #### Pull Request Process
62
-
63
- 1. **Push your branch**:
64
- ```bash
65
- git push origin feature/your-feature-name
66
- ```
67
- 2. **Create a Pull Request** with:
68
- - Clear title and description
69
- - Reference related issues
70
- - Screenshots for UI changes
71
- - Testing instructions
72
-
73
- ## 📋 Coding Standards
74
-
75
- ### Code Style
76
-
77
- - **Use Prettier** for consistent formatting
78
- - **Follow existing patterns** in the codebase
79
- - **Write clear, self-documenting code**
80
- - **Add comments** for complex logic
81
- - **Use meaningful variable names**
82
-
83
- ### File Organization
84
-
85
- - **Components**: Place in `src/components/`
86
- - **Styles**: Use CSS modules or component-scoped styles
87
- - **Assets**: Organize in `src/content/assets/`
88
- - **Documentation**: Update relevant `.mdx` files
89
-
90
- ### Commit Message Format
91
-
92
- We follow [Conventional Commits](https://www.conventionalcommits.org/):
93
-
94
- ```
95
- type(scope): description
96
-
97
- feat: add new interactive chart component
98
- fix: resolve mobile layout issues
99
- docs: update installation instructions
100
- style: improve button hover states
101
- refactor: simplify component structure
102
- test: add unit tests for utility functions
103
- ```
104
-
105
- **Types**: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
106
-
107
- ## 🧪 Testing
108
-
109
- ### Manual Testing
110
-
111
- Before submitting:
112
- - [ ] Test on different screen sizes
113
- - [ ] Verify dark/light theme compatibility
114
- - [ ] Check browser compatibility (Chrome, Firefox, Safari)
115
- - [ ] Test with different content types
116
- - [ ] Ensure accessibility standards
117
-
118
- ### Automated Testing
119
-
120
- ```bash
121
- # Run build to catch errors
122
- npm run build
123
-
124
- # Test PDF export
125
- npm run export:pdf
126
-
127
- # Test LaTeX conversion
128
- npm run latex:convert
129
- ```
130
-
131
- ## 📚 Documentation
132
-
133
- ### Writing Guidelines
134
-
135
- - **Use clear, concise language**
136
- - **Provide examples** for complex features
137
- - **Include screenshots** for UI changes
138
- - **Update both English content and code comments**
139
-
140
- ### Documentation Structure
141
-
142
- - **README.md**: Project overview and quick start
143
- - **CONTRIBUTING.md**: This file
144
- - **Content files**: In `src/content/chapters/demo/`
145
- - **Component docs**: Inline comments and examples
146
-
147
- ## 🎯 Areas for Contribution
148
-
149
- ### High Priority
150
-
151
- - **Bug fixes** and stability improvements
152
- - **Accessibility enhancements**
153
- - **Mobile responsiveness**
154
- - **Performance optimizations**
155
- - **Documentation improvements**
156
-
157
- ### Feature Ideas
158
-
159
- - **New interactive components**
160
- - **Additional export formats**
161
- - **Enhanced LaTeX import**
162
- - **Theme customization**
163
- - **Plugin system**
164
-
165
- ### Community
166
-
167
- - **Answer questions** in discussions
168
- - **Share examples** of your work
169
- - **Write tutorials** and guides
170
- - **Help with translations**
171
-
172
- ## 🚫 What Not to Contribute
173
-
174
- - **Breaking changes** without discussion
175
- - **Major architectural changes** without approval
176
- - **Dependencies** that significantly increase bundle size
177
- - **Features** that don't align with the project's goals
178
-
179
- ## 📞 Getting Help
180
-
181
- - **Discussions**: [Community tab](https://huggingface.co/spaces/tfrere/research-article-template/discussions)
182
- - **Issues**: [Report bugs](https://huggingface.co/spaces/tfrere/research-article-template/discussions?status=open&type=issue)
183
- - **Contact**: [@tfrere](https://huggingface.co/tfrere) on Hugging Face
184
-
185
- ## 📄 License
186
-
187
- By contributing, you agree that your contributions will be licensed under the same [CC-BY-4.0 license](LICENSE) that covers the project.
188
-
189
- ## 🙏 Recognition
190
-
191
- Contributors will be:
192
- - **Listed in acknowledgments** (if desired)
193
- - **Mentioned in release notes** for significant contributions
194
- - **Credited** in relevant documentation
195
-
196
- Thank you for helping make scientific writing more accessible and interactive! 🎉