Contributing to ACK Club
Help shape the future of network simulation documentation. Your code, examples, and feedback directly improve ACK Club's tools and community.
🎯 How You Can Help
Code Contributions
Improve ACK Club's API, add new network simulation features, or optimize code performance. All language-specific contributions are welcome.
Tutorial Authors
Write step-by-step guides for specific protocols, share simulation techniques, or create beginner-focused content.
Documentation
Create API docs, translate pages, or improve clarity throughout the documentation suite.
🧾 Contribution Process
Fork Repository
Locate the ACK Club documentation repository on GitHub and create your own fork.
Create a Topic Branch
Create a unique branch for your changes to maintain clean version history.
Submit a Pull Request
Open a pull request to the ACK Club main repository with clear descriptions of your changes.
- Include detailed explanations of your changes
- Ensure all code follows ACK Club style guidelines
- Make sure documentation is clear and properly formatted
📜 Contribution Standards
Acceptable Contributions
- Technical clarifications
- Code examples in all supported languages
- New feature implementations
- Translated documentation
- Community tutorials
- Performance improvements
Unacceptable Contributions
- Promotional content
- Irrelevant personal stories
- Broken or untested examples
- Unattributed code
- Obscure or overly technical explanations without simplification
💡 Want to Contribute?
You don't need to be a network simulation expert. We welcome contributions of all sizes - from grammar fixes to new tutorials.
👋 First-Time Contributors
We love helping new contributors! Our community maintains a "good first issue" label for documentation, API, and tutorial tasks that are perfect for beginners.
What you'll need:
- Git and GitHub account
- Basic Markdown editing skills
- Text/code editor of choice
- Open mind and willingness to learn
We'll provide:
- Step-by-step contribution guide
- Direct support from maintainers
- Feedback on your pull requests
- Recognition for all contributions
Ready to Contribute?
Every line of code, every word in our documentation, and every tutorial makes ACK Club better for all users.