Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

61 lines (43 loc) · 2.69 KB
Raw

Contributing to String Master

Thank you for your interest in contributing to string-master! We welcome contributions from the community to help improve the library. Please follow the guidelines below to get started.

How to Contribute

1. Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on our GitHub repository. Provide a clear description of the problem and, if possible, steps to reproduce it. Please check our templates for Bug Report and Feature Request.

2. Submitting Pull Requests

To contribute code, follow these steps:

  1. Fork the Repository: Click on the "Fork" button at the top right of this repository to create a copy of the project under your GitHub account.

  2. Clone Your Fork:

    git clone https://github.com/dev-ahmadbilal/string-master.git
cd string-master

  3. Create a Branch: Create a new branch for your changes. Use a descriptive name for the branch.

    git checkout -b your-feature-branch

  4. Make Your Changes:

    Implement your changes or additions. Make sure to follow the existing code style and add tests if applicable.

  5. Commit Your Changes:

    Stage and commit your changes with a clear and concise commit message. We are following conventional commits.

    git add .
git commit -m "feat(scope): add a descriptive message for your changes"

  6. Push Your Branch: Push your branch to your forked repository.

    git push origin your-feature-branch

  7. Create a Pull Request: Go to the Pull Requests section of the main repository and click "New Pull Request." Select your branch and provide a clear description of your changes. Submit the pull request for review. You can check our Pull Request Template.

3. Code of Conduct

Please adhere to our Code of Conduct while participating in discussions or contributing to the project. Treat everyone with respect and kindness.

4. Contribution Guidelines

  • Code Quality: Ensure that your code is well-written, follows the project’s coding standards, and passes all existing and new tests.
  • Documentation: Update the documentation if your changes affect the library’s usage or APIs. Testing: Add or update tests to cover your changes. Make sure all tests pass before submitting your pull request.

5. License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for helping us make string-master better!