Get Involved
Join the EDURange Cloud community and help shape the future of cybersecurity education. There are many ways to contribute, whether you're a developer, educator, or cybersecurity enthusiast.
Ways to Contribute
There are many ways to contribute to EDURange Cloud, regardless of your skill set or experience level
Development Workflow
Follow these steps to contribute code to the EDURange Cloud project
Fork Repository
Start by forking the EDURange Cloud repository to your GitHub account.
# Clone your fork locally git clone https://github.com/your-username/EDURange_Cloud.git cd EDURange_Cloud
Create Branch
Create a new branch for your feature or bug fix with a descriptive name.
# Create and switch to a new branch git checkout -b feature/your-feature-name # Or for bug fixes git checkout -b fix/issue-description
Make Changes
Implement your changes following the code style guidelines and best practices.
# Make your changes and commit them with clear messages git add . git commit -m "Add feature: description of changes" # Push changes to your fork git push origin feature/your-feature-name
Submit Pull Request
Create a pull request against the main branch with a detailed description of your changes.
# Navigate to your fork on GitHub # Click 'Pull Request' # Select the main repository's main branch as the base # Provide a clear title and description
Code Review
Respond to feedback from maintainers and make any requested changes.
# Make requested changes git add . git commit -m "Address review feedback" git push origin feature/your-feature-name # The PR will update automatically
Merge
Once approved, your contribution will be merged into the main codebase.
# Maintainers will merge your PR # You can then update your local main branch git checkout main git pull upstream main
Documentation Contributions
Good documentation is crucial for the success of any open source project. Help us improve EDURange Cloud's documentation in the following areas:
User Guides
Comprehensive guides that help users navigate and use the EDURange Cloud platform effectively.
Examples:
- Installation instructions
- User interface walkthroughs
- Feature explanations
API Documentation
Technical documentation for developers integrating with or extending EDURange Cloud.
Examples:
- API endpoint descriptions
- Authentication mechanisms
- Data structures
Tutorials
Step-by-step instructions for accomplishing specific tasks or implementing certain features.
Examples:
- Creating custom scenarios
- Setting up classroom environments
- Implementing security challenges
Reference Materials
Detailed reference documentation for configuration options, command-line tools, etc.
Examples:
- Configuration file formats
- Environment variables
- CLI command reference
Documentation is written in Markdown format and stored in the docs/ directory of the repository. To contribute, follow the same workflow as code contributions with your documentation changes.
Community Guidelines
We're committed to fostering an inclusive and welcoming community. Please follow these guidelines when participating in the EDURange Cloud project.
Be Respectful and Inclusive
Treat all community members with respect, regardless of their background, identity, experience level, or opinions. Be welcoming to newcomers and help them feel valued.
Communicate Effectively
Be clear and constructive in your communications. Provide context and explain your reasoning. When giving feedback, focus on the idea or code, not the person.
- Be concise but provide enough detail
- Stay on topic in discussions
- Use clear and descriptive titles for issues and pull requests
Follow the Code of Conduct
All participants in the EDURange Cloud community are expected to adhere to our Code of Conduct. This ensures that everyone can participate in a positive and enriching environment.
The full Code of Conduct can be found in the repository.