Skip to content

docs: improve contributing guidelines - checklist, LICENSE link, grammar fixesdocs: improve contributing guidelines - add checklist items, fix LICE… #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hhyags wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve contributing guidelines - checklist, LICENSE link, grammar fixesdocs: improve contributing guidelines - add checklist items, fix LICE… #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ Help make our courses better!

**Process:**
1. Fork the repository
2. Create a branch: `git checkout -b improve-course-name`
2. Create a branch: `git checkout -b fix/course-name-typo`
3. Make your changes
4. Commit: `git commit -m "Improve explanation of XSS in web-security course"`
5. Push: `git push origin improve-course-name`
5. Push: `git push origin fix/course-name-typo`
6. Open a pull request

### 3. Report Issues
Expand Down Expand Up @@ -92,6 +92,8 @@ Your biography goes here. Include:
Use Markdown for formatting.
```

> **Tip:** Check out existing instructor profiles in `_instructors/` (e.g., `sarah-chen.md`, `marcus-rodriguez.md`) for real examples to follow.

### Course Structure

Create `_courses/your-course-slug.md`:
Expand Down Expand Up @@ -157,6 +159,8 @@ Describe labs...
Describe assessments...
```

> **Tip:** See existing courses in `_courses/` (e.g., `web-security-intro.md`, `advanced-pentesting.md`) for real examples of how to structure your course content.

### Content Guidelines

**Writing Style:**
Expand All @@ -170,7 +174,7 @@ Describe assessments...
- Always emphasize ethical use
- Include legal considerations
- Provide safe lab environments
- Warning about dangerous techniques
- Warn about dangerous techniques
- Explain defensive measures

**Accessibility:**
Expand Down Expand Up @@ -252,6 +256,8 @@ git push origin feature/your-feature
- [ ] Verify responsive design
- [ ] Spell-check content
- [ ] Follow existing code style
- [ ] Validate HTML output
- [ ] Verify accessibility (alt text, color contrast, screen reader compatibility)
- [ ] Update documentation if needed

### PR Description
Expand All @@ -265,7 +271,7 @@ Provide:

### Review Process

1. **Automated Checks**: GitHub Actions will run tests
1. **Automated Checks**: GitHub Actions will build and verify the site
2. **Peer Review**: Community members review your PR
3. **Revisions**: Address feedback and make changes
4. **Approval**: Maintainers approve and merge
Expand Down Expand Up @@ -371,7 +377,7 @@ Report issues to conduct@bltuniversity.org

By contributing, you agree:

- Your contributions will be licensed under AGPL-3.0
- Your contributions will be licensed under [AGPL-3.0](LICENSE)
- You have rights to contribute the content
- Your contributions are original or properly attributed
- You understand the license implications
Expand Down