Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (43 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

55 lines (43 loc) · 1.85 KB

How to Contribute

To contribute to this project, please follow these steps:

  1. Fork the repository on GitHub by clicking the "Fork" button.
  2. Clone your fork to your local machine:
git clone https://github.com/YourUsername/till-tool.git 
cd till-tool
  1. Install the required dependencies:
 npm install
  1. Make your changes and enhancements.

Developing Project

  1. I have used Prettier for making code look more beautiful, use the command below:
npm run prettier
  1. I used ESLint for code linting. Run the following command to check for linting issues:
npm run lint

Editor Integration:

Make sure your code editor is set up to utilize the specified configurations for several features. You can find the VSCode settings in the '.vscode/setting.json' file for reference.

  1. Test your changes to ensure they work as expected.
  2. Commit your changes with descriptive commit messages:
git commit -m "Add feature or fix issue"
  1. Push your changes to your fork on GitHub:
git push origin master
  1. Create a pull request (PR) on the original repository. Please provide a clear and concise description of your changes in the PR.

Code Style and Guidelines

  1. Follow the coding style and guidelines used in the existing codebase.
  2. Ensure your code is well-documented, especially if you are introducing new features or making complex changes.

Reporting Issues
If you encounter any issues or have suggestions for improvements, please create an issue on the GitHub repository. Be sure to provide detailed information about the problem and steps to reproduce it.

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

Thank you for your contribution to TEXT-TO-HTML-CONVERTER! Your help is greatly appreciated.