Skip to content

Commit ab7ecac

Browse files
hotlonghotlong
authored
Merge pull request #66 from objectstack-ai/copilot/optimize-document-directory-structure
2 parents b453c2a + db88d61 commit ab7ecac

15 files changed

Lines changed: 3207 additions & 19 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# Changelog
2+
3+
All notable changes to the ObjectStack Protocol will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
- Comprehensive documentation structure with CONTRIBUTING.md
12+
- Documentation hub at docs/README.md
13+
- Standards documentation (naming-conventions, api-design, error-handling)
14+
- Architecture deep dives (data-layer, ui-layer, system-layer)
15+
- Code of Conduct
16+
- Changelog template
17+
- Migration guides structure
18+
- Security and performance guides
19+
20+
### Changed
21+
- Updated README.md with improved documentation navigation
22+
- Enhanced documentation organization following industry best practices
23+
24+
### Deprecated
25+
26+
### Removed
27+
28+
### Fixed
29+
30+
### Security
31+
32+
## [0.1.1] - 2026-01-20
33+
34+
### Added
35+
- Initial protocol specifications
36+
- Zod schemas for data, UI, system, AI, and API protocols
37+
- JSON schema generation
38+
- Basic documentation site with Fumadocs
39+
- Example implementations (CRM, Todo)
40+
41+
## Template for Future Releases
42+
43+
```markdown
44+
## [X.Y.Z] - YYYY-MM-DD
45+
46+
### Added
47+
- New features or capabilities
48+
49+
### Changed
50+
- Changes to existing functionality
51+
52+
### Deprecated
53+
- Features that will be removed in upcoming releases
54+
55+
### Removed
56+
- Features that have been removed
57+
58+
### Fixed
59+
- Bug fixes
60+
61+
### Security
62+
- Security-related changes
63+
```
64+
65+
## How to Use This Changelog
66+
67+
### For Contributors
68+
69+
When making changes:
70+
71+
1. **Add entries under `[Unreleased]`** section
72+
2. **Choose the appropriate category**: Added, Changed, Deprecated, Removed, Fixed, Security
73+
3. **Write clear, concise descriptions** of your changes
74+
4. **Link to PRs or issues** where applicable: `- Feature description (#PR_NUMBER)`
75+
76+
Example:
77+
```markdown
78+
### Added
79+
- New encrypted field type for sensitive data (#123)
80+
- Support for PostgreSQL window functions in query protocol (#124)
81+
82+
### Fixed
83+
- Validation error when using lookup fields with filters (#125)
84+
```
85+
86+
### For Maintainers
87+
88+
When releasing a new version:
89+
90+
1. **Create a new version section** from the `[Unreleased]` content
91+
2. **Move entries** from `[Unreleased]` to the new version section
92+
3. **Add release date** in YYYY-MM-DD format
93+
4. **Tag the release** in git: `git tag -a v0.2.0 -m "Release v0.2.0"`
94+
5. **Update links** at the bottom of the file
95+
96+
### Versioning Guide
97+
98+
Following [Semantic Versioning](https://semver.org/):
99+
100+
- **MAJOR** version (X.0.0): Incompatible API changes
101+
- **MINOR** version (0.X.0): Add functionality in a backward compatible manner
102+
- **PATCH** version (0.0.X): Backward compatible bug fixes
103+
104+
### Categories
105+
106+
- **Added**: New features, protocols, schemas, or capabilities
107+
- **Changed**: Changes to existing functionality
108+
- **Deprecated**: Features marked for removal (but still working)
109+
- **Removed**: Features that have been removed
110+
- **Fixed**: Bug fixes
111+
- **Security**: Security vulnerability fixes or improvements
112+
113+
### Breaking Changes
114+
115+
Mark breaking changes clearly:
116+
117+
```markdown
118+
### Changed
119+
- **BREAKING**: Renamed `maxLength` to `maxLen` in FieldSchema (#126)
120+
Migration: Update all field definitions to use `maxLen` instead of `maxLength`
121+
```
122+
123+
## Release Process
124+
125+
1. Update CHANGELOG.md with release notes
126+
2. Update version in package.json files
127+
3. Run `pnpm changeset version` to update package versions
128+
4. Commit changes: `git commit -m "chore: release vX.Y.Z"`
129+
5. Create git tag: `git tag -a vX.Y.Z -m "Release vX.Y.Z"`
130+
6. Push: `git push && git push --tags`
131+
7. Run `pnpm release` to publish packages
132+
133+
---
134+
135+
[Unreleased]: https://github.com/objectstack-ai/spec/compare/v0.1.1...HEAD
136+
[0.1.1]: https://github.com/objectstack-ai/spec/releases/tag/v0.1.1

‎CODE_OF_CONDUCT.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers responsible for enforcement at [INSERT CONTACT EMAIL]. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from project maintainers, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
76+
77+
[homepage]: https://www.contributor-covenant.org
78+
79+
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)