diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..384e81f0 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,39 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +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. + +## Our Standards + +Examples of behavior that contributes to a positive environment: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior: + +* The use of sexualized language or imagery and unwelcome sexual attention +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information without explicit permission +* Other conduct which could reasonably be considered inappropriate + +## Enforcement Responsibilities + +Community leaders 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. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hello@injectivelabs.org. All complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..1e28fe3c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,121 @@ +# Contributing to Injective SDK Go + +Thank you for your interest in contributing to the Injective Protocol Golang SDK! We welcome contributions from the community. + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [Getting Started](#getting-started) +- [Development Setup](#development-setup) +- [How to Contribute](#how-to-contribute) +- [Pull Request Process](#pull-request-process) +- [Coding Standards](#coding-standards) + +## Code of Conduct + +Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to help maintain a welcoming and inclusive community. + +## Getting Started + +1. Fork the repository on GitHub +2. Clone your fork locally: + ```bash + git clone git@github.com:YOUR_USERNAME/sdk-go.git + cd sdk-go + ``` +3. Add the upstream repository: + ```bash + git remote add upstream https://github.com/InjectiveLabs/sdk-go.git + ``` + +## Development Setup + +### Prerequisites + +- Go 1.21 or later +- Make +- Git + +### Installation + +```bash +go mod download +``` + +### Running Tests + +```bash +make tests +``` + +### Running Linter + +```bash +make lint +``` + +## How to Contribute + +### Reporting Bugs + +- Check if the bug has already been reported in [Issues](https://github.com/InjectiveLabs/sdk-go/issues) +- If not, create a new issue with a clear title and description +- Include steps to reproduce the bug +- Add relevant code samples or error messages + +### Suggesting Enhancements + +- Open a new issue describing your enhancement +- Explain why this enhancement would be useful +- Provide examples of how it would work + +### Code Contributions + +1. Create a new branch from `dev`: + ```bash + git checkout -b feature/your-feature-name + ``` +2. Make your changes +3. Write or update tests as needed +4. Run tests and linter +5. Commit your changes with a descriptive message +6. Push to your fork and submit a pull request + +## Pull Request Process + +1. Ensure your code follows the project's coding standards +2. Update documentation if needed +3. Add tests for new functionality +4. Ensure all tests pass +5. Update the README.md if necessary +6. Request review from maintainers + +### Commit Message Guidelines + +- Use clear, descriptive commit messages +- Start with a verb in the present tense (e.g., "Add", "Fix", "Update") +- Reference issues when applicable (e.g., "Fix #123") + +Examples: +``` +feat: add new market query method +fix: resolve connection timeout issue +docs: update README with new examples +``` + +## Coding Standards + +- Follow Go best practices and idioms +- Use `gofmt` to format your code +- Write clear comments for exported functions +- Keep functions focused and concise +- Handle errors appropriately + +## Questions? + +If you have questions, feel free to: +- Open an issue +- Reach out on [Twitter](https://twitter.com/InjectiveLabs) +- Visit [injective.com](https://injective.com) + +Thank you for contributing! 🚀 diff --git a/NOTICE.md b/NOTICE.md index 9e73b26c..a401c31c 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -1,4 +1,4 @@ -Copyright © 2020 - 2022 Injective Labs Inc. (https://injectivelabs.org/) +Copyright © 2020 - 2025 Injective Labs Inc. (https://injectivelabs.org/) diff --git a/README.md b/README.md index c07d3721..b8707647 100644 --- a/README.md +++ b/README.md @@ -122,3 +122,11 @@ Originally released by Injective Labs Inc. under:
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/ + +--- + +## Contributing + +We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to get started. + +Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.