Contributing to devrel.directory
Guidelines for contributing to this DevRel resource
Contributing to devrel.directory
We welcome contributions from the DevRel community to help improve and expand this resource. Your expertise and insights can help make devrel.directory a comprehensive and valuable tool for Developer Relations professionals worldwide.
How to Contribute
There are several ways you can contribute to devrel.directory:
- Content Additions: Add new topics, expand existing sections, or provide case studies and examples.
- Content Improvements: Enhance existing content by adding more details, clarifying explanations, or updating outdated information.
- Proofreading and Editing: Help improve the overall quality of the content by fixing typos, grammatical errors, and improving readability.
- Translations: Assist in translating content to other languages to make the resource more accessible globally.
- Suggestions and Feedback: Provide ideas for new topics or improvements to the structure and organization of the content.
Contribution Process
-
Fork the Repository: Start by forking the devrel.directory repository on GitHub.
-
Create a Branch: Create a new branch for your contributions with a descriptive name.
-
Make Changes: Add or edit content in the appropriate files. Ensure you follow the existing formatting and style guidelines.
-
Commit Changes: Commit your changes with clear and concise commit messages.
-
Create a Pull Request: Submit a pull request from your branch to the main repository. Provide a detailed description of your changes and the rationale behind them.
-
Review Process: Your contribution will be reviewed by the maintainers. They may request changes or clarifications.
-
Merge: Once approved, your contribution will be merged into the main branch.
Content Guidelines
- Use clear and concise language.
- Provide practical examples and real-world scenarios when possible.
- Cite sources for statistics, quotes, or specific claims.
- Ensure content is vendor-neutral unless specifically discussing a particular tool or platform.
- Follow the existing structure and formatting of the documentation.
Code of Conduct
We are committed to providing a welcoming and inclusive environment for all contributors. Please adhere to our Code of Conduct in all interactions related to this project.
Getting Help
If you have any questions about contributing or need assistance, please don't hesitate to reach out by:
- Opening an issue on GitHub
- Sending a message to @0xfabs on X
Thank you for your interest in contributing to devrel.directory. Your efforts help make this resource valuable for the entire DevRel community!