Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (54 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

81 lines (54 loc) · 3.46 KB
Raw

Contributing to SLIDE SDK

First off, thank you for considering contributing to SLIDE SDK! It's people like you that make SLIDE SDK such a great tool.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please note that this project is released with a Contributor Code of Conduct. By participating, you agree to abide by its terms.

Important Note

SLIDE SDK is licensed under the Business Source License 1.1 (BUSL-1.1). Please make sure you understand the implications of this license before contributing.

How Can I Contribute?

Reporting Bugs

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  • Open a new issue with a clear title and detailed description of the suggested enhancement.
  • Provide any relevant examples or use cases that support your suggestion.

Pull Requests

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Ensure your code adheres to our coding standards.
  4. If you've added code that should be tested, add tests.
  5. Ensure the test suite passes.
  6. Make sure your code lints.
  7. Open a pull request with a clear description of your changes.
  8. Reference any related issues in your pull request.

Development Setup and Testing

For development setup and testing instructions, please follow our docs at: https://docs.landslide.network/

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Go Styleguide

We follow the Effective Go guidelines and Go Code Review Comments for our Go code. Please ensure your contributions adhere to these standards.

Documentation Styleguide

  • Use Markdown for documentation.
  • Write clear, concise, and grammatically correct content.
  • Use headers to organize content hierarchically.
  • Include code examples where appropriate, using proper syntax highlighting.
  • Keep documentation up-to-date with code changes.

Issue and Pull Request Labels

We use the following labels to categorize issues and pull requests:

  • bug: Indicates an unexpected problem or unintended behavior
  • enhancement: Indicates new feature requests or improvements to existing features
  • documentation: Relates to improvements or additions to documentation
  • good first issue: Good for newcomers to the project
  • help wanted: Extra attention is needed
  • question: Further information is requested
  • security: Relates to security issues
  • performance: Addresses performance-related aspects
  • refactor: Code refactoring without changing functionality
  • test: Relates to testing infrastructure or test cases

Questions?

If you have any questions, please feel free to contact the project maintainers.

Thank you for contributing to SLIDE SDK!