Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

100 lines (63 loc) · 3.72 KB

Contributing to String Methods

Thank you for considering contributing to String Methods! We welcome contributions from the community to help improve and maintain this project. By participating, you can make valuable contributions, whether they involve code, documentation, bug reports, feature requests, or general feedback.

Please take a moment to review this document to understand how to contribute effectively.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Development Setup
  4. Pull Request Guidelines
  5. Community
  6. License

Code of Conduct

This project follows the Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to Pabitra Banerjee

How Can I Contribute?

There are several ways to contribute to this project:

Reporting Bugs

If you encounter a bug or issue with the project, please open a new GitHub Issue with a clear and detailed description. Include any relevant information to help reproduce the issue.

Suggesting Enhancements

If you have ideas for new features or enhancements, please open a new GitHub Issue with your suggestions. Describe the proposed changes and their potential benefits.

Code Contributions

If you want to contribute code to the project, please follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone your forked repository to your local machine.
git clone https://github.com/pb2204/String-Methods.git
  1. Create a new branch for your contribution.
git checkout -b feature/your-feature-name
  1. Write your code and make changes.
  2. Write tests for your code (if applicable) and ensure all tests pass.
npm test
  1. Commit your changes using descriptive commit messages (see Commit Message Guidelines).
git commit -m "feat: Add new feature"
  1. Push your changes to your GitHub repository.
git push origin feature/your-feature-name
  1. Open a new pull request (PR) from your forked repository to the main project repository. Provide a clear description of your changes in the PR.

Documentation Contributions

Improvements to project documentation are highly valuable. If you find errors or areas for improvement in the documentation, please contribute by following these steps:

  1. Fork the repository.
  2. Make changes to the documentation.
  3. Commit your changes with informative commit messages.
  4. Push your changes to your fork.
  5. Open a pull request to the main project repository.

Commit Message Guidelines

We follow Conventional Commits for commit messages. Please use this format for your commit messages to maintain clarity and consistency in the commit history.

Pull Request Guidelines

Before submitting a pull request, ensure that your code adheres to the coding standards and conventions of the project. Your PR will be reviewed, and changes may be requested before merging. Please provide context and explanations for your changes in the PR description.

Community

Join our community to discuss project-related topics, ask questions, and get assistance:

License

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