-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Aleksei Gurianov <[email protected]>
- Loading branch information
Showing
4 changed files
with
105 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# Contributing to GleoJSON | ||
|
||
Thank you for your interest in contributing to GleoJSON! We welcome contributions from the community to help improve and grow this project. This document outlines the process for contributing to GleoJSON. | ||
|
||
## Getting Started | ||
|
||
1. Fork the repository on GitHub. | ||
2. Clone your fork locally: | ||
``` | ||
git clone https://github.com/guria/gleojson.git | ||
cd gleojson | ||
``` | ||
3. Set up your development environment with Gleam. If you haven't installed Gleam yet, follow the [official installation guide](https://gleam.run/getting-started/index.html). | ||
|
||
## Making Changes | ||
|
||
1. Create a new branch for your feature or bug fix: | ||
``` | ||
git checkout -b your-feature-branch | ||
``` | ||
2. Make your changes in the relevant files under the `src/` directory. | ||
3. Add or update tests as necessary in the `test/` directory. | ||
4. Run the tests to ensure your changes don't break existing functionality: | ||
``` | ||
gleam test | ||
``` | ||
5. Update the documentation if your changes affect the public API or user-facing features. | ||
|
||
## Submitting Changes | ||
|
||
1. Commit your changes with a clear and descriptive commit message: | ||
``` | ||
git commit -am "Add a brief description of your changes" | ||
``` | ||
2. Push your branch to your fork on GitHub: | ||
``` | ||
git push origin your-feature-branch | ||
``` | ||
3. Open a pull request against the main repository's `main` branch. | ||
4. In your pull request description, explain the changes you've made and why they're necessary. | ||
|
||
## Code Style and Standards | ||
|
||
- Write clear, concise comments and documentation. | ||
- Ensure your code is well-tested. | ||
|
||
## Reporting Issues | ||
|
||
If you find a bug or have a suggestion for improvement: | ||
|
||
1. Check the [GitHub Issues](https://github.com/guria/gleojson/issues) to see if it has already been reported. | ||
2. If not, open a new issue, providing as much detail as possible about the problem or suggestion. | ||
|
||
## Community and Communication | ||
|
||
- Join the [Gleam Discord](https://discord.gg/Fm8Pwmy) for discussions and questions. | ||
- Be respectful and considerate in all interactions. | ||
|
||
## License | ||
|
||
By contributing to GleoJSON, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE) file. | ||
|
||
Thank you for contributing to GleoJSON! | ||
|
||
# Developer Certificate of Origin | ||
|
||
By making a contribution to this project, I certify that: | ||
|
||
1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or | ||
|
||
2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Copyright 2024 Aleksei Gurianov | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# NOTICE | ||
|
||
Copyright (c) 2024 Aleksei Gurianov and contributors. | ||
This project is licensed under the MIT License. See the LICENSE file for the full license text. | ||
|
||
## AI Assistance Acknowledgment | ||
|
||
This project was bootstrapped with assistance from the OpenAI `o1-preview` model. | ||
It was used to scaffold basic types and encoder/decoder functions according to [RFC 7946](https://datatracker.ietf.org/doc/html/rfc7946). | ||
Manual edits were made to adjust the generated code to the actual Gleam language and to fix compilation errors. | ||
Captured assistance session could be found in initial commit message. | ||
|
||
Other AI models from different providers were used to provide suggestions, generate initial code structures, and assist in problem-solving during the early stages of development. | ||
|
||
It's important to note that while AI assistance was used, all final decisions, implementations, and the overall direction of the project were determined by human developers. | ||
|
||
## Copyrights and Licenses for Third Party Software | ||
|
||
Package dependencies are defined in the `gleam.toml` file in the top-level directory of the project and have their own licenses and terms. | ||
|
||
## Additional Notices | ||
|
||
This NOTICE file is provided for informational purposes and does not modify the license terms of this software or any third-party software acknowledged herein. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters