Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 3 KB
Raw

Contributing to Metadata Bank API SDK

Thank you for considering contributing to the Metadata Bank API SDK! Your contributions, bug reports, and suggestions are highly appreciated. Below you'll find guidelines and information on how to participate in this project.

Code of Conduct

By participating in this project, you are expected to adhere to our Code of Conduct. Please make sure to read and understand the full text before engaging with the community.

How to Contribute

Reporting Bugs

  • Check existing issues: Before submitting a new bug report, please search the existing issues to see if someone else has already reported it.
  • Create a new issue: If the issue is not already reported, please create a new issue and provide a clear description of the problem, steps to reproduce, expected behavior, and any relevant error messages or logs.

Suggesting Enhancements

  • Create a new issue: Describe the enhancement, explain why it would be useful, and provide any relevant examples or additional information.

Contributing Code

  1. Fork the repository: Click the "Fork" button at the top-right of this page to create your own copy of the repository.
  2. Clone your fork: Clone the repository to your local machine using git clone https://github.com/pbs-sdo/mbank-api-sdk.git.
  3. Create a new branch: Create a new branch for your feature or bug fix using git checkout -b my-new-feature.
  4. Make your changes: Implement your changes, following the coding standards and guidelines described below.
  5. Commit your changes: Commit your changes using a descriptive commit message that explains what you've done.
  6. Push to your fork: Push your changes to your fork on GitHub using git push origin my-new-feature.
  7. Create a pull request: Open a pull request against the main repository, providing a clear description of your changes and any additional information that might be helpful for reviewers.

Coding Standards

  • Follow the coding style: Please adhere to the coding style used throughout the project.
  • Write tests: If you are adding new functionality, please include appropriate test cases.
  • Update documentation: Ensure that your code changes are reflected in the relevant documentation, such as README files or inline comments.

Review Process

  • Wait for a review: Maintainers will review your pull request as soon as possible. Please be patient and address any feedback or questions.
  • Make requested changes: If changes are requested, make the necessary updates and push them to your branch.

Acknowledgments

Contributors will be acknowledged in the project's documentation, and we are grateful for every contribution, no matter how small!

Questions?

If you have any questions or need further clarification on anything related to contributing, please feel free to reach out by creating an issue or emailing metadata-api-sdk.

Thank you for helping to improve Metadata Bank API SDK!