From 77ceb31d26986516f192a7a12e6d2c57a1acbad6 Mon Sep 17 00:00:00 2001 From: Faruk Eryilmaz Date: Mon, 8 Jan 2024 01:33:51 +0300 Subject: [PATCH] add reference to roadmap_draft.md file and fix related links --- CONTRIBUTING.md | 14 +++++--------- README.md | 5 +++++ doc/README.md | 4 ++-- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7a18574..b0ca3d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,19 @@ # Contributing to BytePack First off, thank you for considering contributing to BytePack. Whether you're fixing a bug, writing a test, adding a feature, or improving documentation, your work is important to the growth of BytePack. It's people like you that make the open-source community such a fantastic place to learn, inspire, and create. -> Before submitting code changes, feedback or suggestions, please read the [Motivation & Design Philosophy of BytePack](doc/design_philosophy.md) +> **Note:** Before submitting code changes, feedback or suggestions, please read [Motivation & Design Philosophy of BytePack](doc/design_philosophy.md) and [Roadmap Draft](doc/roadmap_draft.md) documents. ## Ways to Contribute -### 1) Reporting Bugs +### 1) Feedback and Suggestions +Ideas for new features or suggestions for improvements to existing functionality are always welcome. Feel free to submit an issue with your suggestion (e-mails are also welcome). +### 2) Reporting Bugs Bugs are tracked publicly as GitHub issues (e-mails are also welcome). Before creating bug reports, please check the [issue list](https://github.com/farukeryilmaz/bytepack/issues) as you might find out that you don't need to create one. When you are creating a bug report, please provide as much detail as possible, including: - The expected behavior and what actually happened. - Steps to reproduce the bug or copy/pasteable code snippets. - Your environment details (OS, compiler version, etc.). -### 2) Suggesting Enhancements - -Ideas for new features or suggestions for improvements to existing functionality are always welcome. Feel free to submit an issue with your suggestion (e-mails are also welcome). - ### 3) Submitting Code Changes Bug fixes, feature enhancements, code examples and documentation, unit tests, performance improvements and security fixes are highly appreciated. If you'd like to contribute code, please read the section below on how to do this. @@ -43,16 +41,14 @@ Ready to contribute code or documentation? Great! Here's how: ### Code Formatting BytePack adheres to a consistent coding style to maintain the readability and maintainability of the code. `clang-format` tool is used for automatic code formatting. A `.clang-format` file is provided at the root of the repository. Please ensure your contributions follow this style. -- Formatting Your Code: Before commiting and submitting your pull request, please format your code using clang-format. +- Formatting Your Code: Before committing and submitting your pull request, please format your code using clang-format. 1. Go to root directory of the project. 2. Run the command on the command-line: `clang-format -i ./include/bytepack/bytepack.hpp` Adhering to these formatting guidelines helps me efficiently review and merge your contributions. ### Use of Third-Party Libraries - If you want to add a third-party library, please submit a GitHub issue to discuss it before making significant changes. ## Community and Communication - Direct communication through GitHub issues and pull requests is the primary way to discuss the project. If you have any questions or want to discuss a feature idea, feel free to open an issue. You can also reach out to me directly via e-mail: `faruk [at] farukeryilmaz [dot] com` \ No newline at end of file diff --git a/README.md b/README.md index d9aceeb..91f0ca3 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,11 @@ Include the library in your C++ project: BytePack is a C++ library crafted with a clear focus on simplicity and flexibility in binary serialization, primarily for network communication. It does not enforce any standardization, versioning, or the use of Interface Description Language (IDL) in serialization, providing you with the freedom to define your data structures and protocols. This approach is ideal when interfacing with systems where data formats and protocols are defined externally, as is often the case in standards like IEEE 12207, Interface Control Documents (ICD), Interface Design Description (IDD), and other industry-specific specifications. It allows you to seamlessly integrate BytePack into diverse projects, accommodating a wide range of requirements and compliance standards. > For more details: [Motivation & Design Philosophy of BytePack](doc/design_philosophy.md) +## Roadmap Draft (Community-Driven) +> Read the [Roadmap Draft](doc/roadmap_draft.md) document for more details. + +Explore the detailed roadmap of BytePack. This living document includes various development stages from solid concepts to initial ideas, awaiting community feedback. Discover API explorations, feature considerations, and potential solutions. + ## Contributions and Feedback Contributions are welcome! If you encounter issues, have suggestions, or want to contribute to the development of the library, please read the [Contribution Guideline](CONTRIBUTING.md). diff --git a/doc/README.md b/doc/README.md index f3720d3..d9dcf97 100644 --- a/doc/README.md +++ b/doc/README.md @@ -3,6 +3,6 @@ - [Motivation & Design Philosophy](design_philosophy.md) - [Installation & Running Tests](installation_and_test.md) - [User Guide & API Reference](user_guide.md) -- [Usage Examples](../examples/README.md) -- [Exploratory Ideas & Future Considerations]() _(coming soon)_ +- [Usage Examples (ASIO, Qt, Raw Sockets)](../examples/README.md) +- [Roadmap Draft (Community-Driven)](roadmap_draft.md) - [Contribution Guideline](../CONTRIBUTING.md)