Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

54 lines (38 loc) · 2.09 KB

Contributing

Thank you for considering contributing to Fibrous SDK! We appreciate your time and effort. Please take a moment to review the guidelines below.

Issue Tracker

If you find any bugs or have a feature request, please open an issue on the issue tracker. We welcome bug reports, feature suggestions, and pull requests.

Pull Requests

  1. Fork the repository and create your branch from main.
  2. Make sure your code follows our code style and conventions.
  3. Ensure that your commits are concise, well-documented, and address a specific issue.
  4. Commit messages should follow the format:
fix: Brief description of the fix
feat: Brief description of the feature
chore: Non-breaking change

For example:

fix: Correct the typo in the README file
feat: Implement a new authentication module
chore: Update dependencies to the latest version
  1. If your pull request addresses an issue, reference it using the syntax Fixes #issue_number in the commit message.
  2. Push your changes to your forked repository.
  3. Submit a pull request to the main branch of the original repository.
  4. Provide a clear and descriptive title for your pull request and explain the motivation behind the changes.
  5. Be responsive to any feedback or questions that may arise during the review process.

Code Style and Conventions

Please adhere to the following guidelines when submitting code:

  • Use 4 spaces for indentation.
  • Follow the naming conventions for variables, functions, and classes.
  • Write clear and concise comments to explain the code's intent.
  • Keep code lines within a reasonable length (usually less than 80 characters).
  • Avoid unnecessary dependencies and ensure all external packages are properly licensed.

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.

Conclusion

We greatly appreciate your contribution! Your efforts will help make this project even better. If you have any questions or need further assistance, please don't hesitate to reach out.