Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

76 lines (47 loc) · 3.29 KB
Raw

Contribution Guidelines

Introduction

Thank you for your interest in contributing to atpctrl. A command-line tool that enables the manipulation of SNS accounts in accordance with the AT protocol.

How to Contribute

Contributions to atpctrl are warmly welcomed and appreciated. Here are the areas where you can help:

  • Code Contributions: This includes bug fixes, updating models and methods to adhere to the latest standards, and enhancing the library’s efficiency.
  • Documentation: Assist in sourcing the most recent documentation, documenting all project components, and enhancing DocC (creating tutorials, writing articles, and organizing content).
  • Testing: Ensure that the project is built, runs, and functions correctly on all supported platforms, including iOS, iPadOS, macOS, tvOS, watchOS, and visionOS.

Contribution Process

Setting Up Your Environment

  1. Fork the atpctrl repository and clone it to your local machine.
  2. Open the project with your IDE of choice.

Making Changes

  • For new features and improvements, modify the develop branch.
  • For bug fixes, modify the main branch.
  • Complete the Pull Request form, providing all necessary details before submitting your pull request.

Code Style

  • Adhere to the Swift API Design Guidelines.
  • Ensure that asynchronous tasks utilize Swift Concurrency.
  • To adhere to the guidelines, the swift-format command will be enforced through GitHub Actions.

Documentation

  • Ensure all methods, functions, properties, enums, protocols, variables, parameters, and other elements are well-documented.
  • Documentation should be concise and straightforward. Use larger documentation headers to explain important details, with examples and notes as needed.

Testi

  • Before submitting a pull request, ensure that all tests in the test suite pass by running the test suite.
  • Additionally, ensure that any new test code reflects the changes you made and is up-to-date with the latest codebase.

Submitting Your Contribution

Contributions should be made in the following manner:

  1. Submit suggestions in the Issues section and ensure their acceptance.
  2. Fork the repository.
  3. Create a feature branch.
  4. Commit your changes.
  5. Push your changes to the branch.
  6. Test your code before creating a new Pull Request.
  7. Create a new Pull Request.

Warning: Ensure that your pull request targets the develop branch, except when fixing bugs in the main branch.

Code Review

Once submitted, your pull request will be reviewed. Engage with any feedback provided to ensure your contribution meets the project’s standards.

Community Standards

atpctrl adheres to the Contributor Covenant Code of Conduct to create an inclusive and respectful environment for all users. Harassment of any kind is strictly prohibited. Kindly review the Code of Conduct for further details.

Help

Should you have any inquiries or require assistance, please do not hesitate to contact me.

You may reach me via email at: [email protected]

Your interest, assistance, and feedback are invaluable in enhancing the atpctrl library. Thank you for your continued support.

Keisuke Chinone
GitHub: KC-2001MS