Skip to content

Commit 2ef8664

Browse files
Ranchhand87Ranchhand87
authored
Merge pull request #69 from thisisobate/fix/64
chore: remove duplicate file for CONTRIBUTING.md
2 parents 0be3b2d + 7d825ae commit 2ef8664

2 files changed

Lines changed: 221 additions & 334 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 221 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -1,112 +1,221 @@
1-
# Contributing to the Developer Experience repository
2-
3-
## How to Contribute Using VS Code
4-
5-
1. **Fork the repository:**
6-
7-
- Navigate to the [repository](https://github.com/IntersectMBO/developer-experience).
8-
- Click the Fork button to create a fork of the repository.
9-
- A fork of the repository will be created in your profile, copy that URL.
10-
11-
2. **Clone the Fork:**
12-
- Open Visual Studio Code.
13-
14-
- Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on macOS) to open the Command Palette.
15-
- Type `Git: Clone` and select it.
16-
17-
- Paste the repository URL: Paste the copied URL from Step 1.
18-
- Choose a directory to save the project.
19-
20-
3. **Navigate to the Project Directory:**
21-
- Open the cloned project in VS Code.
22-
23-
- Use the integrated terminal (Ctrl+`` or Cmd+`` on macOS) if needed.
24-
25-
4. **Create a Branch for Your Changes:**
26-
- Click the branch name in the bottom-left corner of VS Code.
27-
28-
- Select `+Create new branch....`
29-
30-
- Enter a branch name (e.g., new-branch-name).
31-
32-
- Press Enter.
33-
34-
5. **Work on Your Changes and Push to the Branch:**
35-
- Make your changes in the respective files.
36-
37-
- Go to the Source Control tab (`Ctrl+Shift+G` on Windows or `Cmd+Shift+G` on macOS).
38-
39-
- Stage your changes by clicking the `+` icon next to each file or the "Stage All Changes" button.
40-
41-
- Enter a commit message in the input box and click the checkmark to commit.
42-
43-
- Click the `...` menu in the Source Control tab and select Push.
44-
45-
6. **Make a Pull Request:**
46-
- Go to your forked repository page on GitHub.
47-
48-
- Click the `New Pull Request` button.
49-
50-
- Select your branch and provide a clear description of your changes.
51-
52-
- Submit the PR for review.
53-
54-
7. **Follow the Review Process**
55-
56-
- Your PR will be reviewed by the [CODEOWNERS](./CODEOWNERS) of the project. You may be asked to make changes or improvements before your contribution is merged. Please be patient and responsive to any feedback.
57-
58-
## How to Contribute Using Terminal
59-
60-
1. **Fork the Repository:**
61-
- Navigate to the [repository](https://github.com/IntersectMBO/developer-experience).
62-
63-
- Click the Fork button to create a fork of the repository.
64-
65-
- A fork of the repository will be created in your profile, copy that URL.
66-
67-
2. **Create a Project Directory and Clone the Fork:**
68-
- Open a New Terminal in Visual Studio Code.
69-
- Create your project's root directory using `mkdir folder-name`and navigate to it using `cd folder-name`.
70-
- Run the following command:
71-
```shell
72-
git clone copied-url
73-
```
74-
75-
3. **Navigate to the Project Directory:**
76-
- Run the following command:
77-
78-
```shell
79-
cd developer-experience
80-
```
81-
4. **Create a Branch for Your Changes:**
82-
- Run the following command:
83-
```shell
84-
git checkout -b new-branch-name
85-
```
86-
5. **Work on Your Changes and Push to the Branch**
87-
- Make your changes in the respective files.
88-
- Stage your changes:
89-
```shell
90-
git add .
91-
```
92-
- Commit your changes:
93-
```shell
94-
git commit -m "short description for the commit"
95-
```
96-
- Push your changes:
97-
```shell
98-
git push
99-
```
100-
6. **Make a Pull Request:**
101-
- Go to your forked repository page on GitHub.
102-
- Click the `New Pull Request` button.
103-
- Select your branch and provide a clear description of your changes.
104-
- Submit the PR for review.
105-
106-
7. **Follow the Review Process**
107-
108-
- Your PR will be reviewed by the [CODEOWNERS](./CODEOWNERS) of the project. You may be asked to make changes or improvements before your contribution is merged. Please be patient and responsive to any feedback.
109-
110-
111-
This project and everyone participating in it is governed by the [Code of Conduct](./CODE-OF-CONDUCT.md).
112-
By participating, you are expected to uphold this code.
1+
# Contributing to Cardano Developer Experience
2+
3+
Thank you for your interest in contributing to the Cardano Developer Experience documentation! This repository aims to provide comprehensive, accessible resources for developers and contributors in the Cardano ecosystem.
4+
5+
## Ways to Contribute
6+
7+
### 1. Documentation Improvements
8+
- Fix typos, grammar, or formatting issues
9+
- Update outdated information
10+
- Add new guides or tutorials
11+
- Improve existing explanations
12+
- Translate content to other languages
13+
14+
### 2. Code Examples
15+
- Add practical code examples to guides
16+
- Create new hands-on tutorials
17+
- Update examples for latest versions
18+
- Add comments and explanations to existing code
19+
20+
### 3. Community Resources
21+
- Update community links and channels
22+
- Add new tools and resources
23+
- Share developer stories and experiences
24+
- Contribute to troubleshooting guides
25+
26+
### 4. Testing and Feedback
27+
- Test tutorials and report issues
28+
- Provide feedback on content clarity
29+
- Suggest improvements to structure
30+
- Report broken links or outdated information
31+
32+
## Getting Started
33+
34+
### Prerequisites
35+
- Node.js (v16 or higher)
36+
- npm or yarn
37+
- Git
38+
- Basic understanding of Markdown
39+
40+
### Local Development Setup
41+
42+
1. **Fork and Clone**
43+
```bash
44+
git clone https://github.com/YOUR_USERNAME/developer-experience.git
45+
cd developer-experience/website
46+
```
47+
48+
2. **Install Dependencies**
49+
```bash
50+
npm install
51+
```
52+
53+
3. **Start Local Server**
54+
```bash
55+
npm start
56+
```
57+
58+
4. **Make Changes**
59+
- Edit files in the `docs/` directory
60+
- Changes are reflected in real-time
61+
62+
### Documentation File Structure
63+
64+
```
65+
docs/
66+
├── how-to-guide/
67+
│ ├── beginner/ # Beginner guides
68+
│ ├── intermediate/ # Intermediate guides
69+
│ ├── advanced/ # Advanced guides
70+
├── tutorials/ # Interactive tutorials
71+
├── resources/
72+
│ ├── repositories.md # Repository guides
73+
│ ├── tools.md # Tool documentation
74+
│ └── community.md # Community resources
75+
├── working-group/ # DevEx Working Group materials
76+
├── intersect-membership-guide.md # How to become a cardano community member
77+
└── getting-started.md # Main onboarding guide
78+
```
79+
80+
## Contribution Guidelines
81+
82+
### Content Standards
83+
84+
#### Writing Style
85+
- Use clear, concise language
86+
- Write for your target audience (beginner/intermediate/advanced)
87+
- Include practical examples where possible
88+
- Use active voice
89+
- Explain technical terms
90+
91+
#### Formatting
92+
- Use proper Markdown syntax
93+
- Include code blocks with syntax highlighting
94+
- Use headings to structure content
95+
- Add links to external resources
96+
- Include images/diagrams when helpful
97+
98+
#### Code Examples
99+
- Test all code examples before submitting
100+
- Use the latest stable versions
101+
- Include necessary imports and dependencies
102+
- Add comments explaining complex parts
103+
- Provide complete, runnable examples
104+
105+
### Submission Process
106+
107+
#### For Small Changes
108+
1. Fork the repository
109+
2. Create a feature branch: `git checkout -b fix/update-documentation`
110+
3. Make your changes
111+
4. Test locally: `npm start`
112+
5. Commit with descriptive message: `git commit -m "Fix typo in environment setup guide"`
113+
6. Push to your fork: `git push origin fix/update-documentation`
114+
7. Create a Pull Request
115+
116+
#### For Large Changes
117+
1. **First, create an issue** to discuss the proposed changes
118+
2. Get feedback from maintainers
119+
3. Follow the same process as small changes
120+
4. Reference the issue in your PR description
121+
122+
### Pull Request Guidelines
123+
124+
#### PR Description Template
125+
```markdown
126+
## Description
127+
Brief description of changes made.
128+
129+
## Type of Change
130+
- [ ] Bug fix (non-breaking change which fixes an issue)
131+
- [ ] New feature (non-breaking change which adds functionality)
132+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
133+
- [ ] Documentation update
134+
135+
## Testing
136+
- [ ] I have tested these changes locally
137+
- [ ] I have checked for broken links
138+
- [ ] Code examples have been tested
139+
140+
## Checklist
141+
- [ ] My code follows the style guidelines
142+
- [ ] I have performed a self-review
143+
- [ ] I have made corresponding changes to documentation
144+
- [ ] My changes generate no new warnings
145+
```
146+
147+
#### Review Process
148+
1. Automated checks will run on your PR
149+
2. Maintainers will review within 48 hours
150+
3. Address any feedback or requested changes
151+
4. Once approved, your PR will be merged
152+
153+
## Content Guidelines
154+
155+
### Documentation Structure
156+
- Start with clear objectives
157+
- Provide prerequisites
158+
- Use step-by-step instructions
159+
- Include troubleshooting sections
160+
- End with next steps or related resources
161+
162+
### Code Examples
163+
- Always use syntax highlighting: \`\`\`language
164+
- Include file paths for real code: \`\`\`javascript path=/path/to/file.js start=10
165+
- Use null values for hypothetical code: \`\`\`javascript path=null start=null
166+
- Test all examples before submission
167+
168+
### Links and References
169+
- Use descriptive link text
170+
- Prefer official sources
171+
- Check links are working before submission
172+
- Use relative links for internal content
173+
174+
## Community Guidelines
175+
176+
### Be Respectful
177+
- Treat all community members with respect
178+
- Be constructive in feedback
179+
- Help newcomers learn and contribute
180+
- Celebrate diverse perspectives and backgrounds
181+
182+
### Be Collaborative
183+
- Discuss major changes before implementing
184+
- Ask for help when needed
185+
- Share knowledge and resources
186+
- Credit contributors appropriately
187+
188+
### Stay Focused
189+
- Keep discussions relevant to the project
190+
- Follow the established structure and patterns
191+
- Maintain consistency with existing content
192+
- Focus on improving developer experience
193+
194+
## Getting Help
195+
196+
### Questions and Support
197+
- **Discord**: First become a member at [Intersect](https://www.intersectmbo.org/) and register at [members.intersectmbo.org](https://members.intersectmbo.org/registration) to get voting rights, participate in governance decisions, and access our Discord community's #developer-experience channel. See our [Intersect Membership Guide](docs/intersect-membership-guide.md) for all benefits
198+
- **Issues**: Create an issue for bug reports or feature requests
199+
- **Discussions**: Use GitHub Discussions for questions and ideas
200+
201+
### Working Group
202+
- Join the Developer Experience Working Group
203+
- Attend weekly sessions for real-time collaboration
204+
- Contribute to session planning and content creation
205+
206+
## Recognition
207+
208+
Contributors are recognized in:
209+
- README.md contributor section
210+
- Session credits for working group contributions
211+
- Community shout-outs in Discord and social media
212+
213+
## License
214+
215+
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
216+
217+
---
218+
219+
Thank you for helping make Cardano more accessible to developers worldwide! 🚀
220+
221+
*For questions about contributing, first become a member at [Intersect](https://www.intersectmbo.org/) and register at [members.intersectmbo.org](https://members.intersectmbo.org/registration) to get voting rights and access to our Discord community's #developer-experience channel. See our [Intersect Membership Guide](docs/intersect-membership-guide.md) for all membership benefits.*

0 commit comments

Comments
 (0)