luciano/markitdown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

first draft contributing.md

Browse source
This commit is contained in:
Lalitha A R 2024-12-25 13:35:52 +05:30 committed by GitHub
parent b08ef8a987
commit 35f08a337f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/contributor-guide/contributing.md
View file

@ -1,7 +1,15 @@
## Contributing # How to Contribute
This project welcomes contributions and suggestions. Most contributions require you to agree to a This project welcomes contributions and suggestions.
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
## Steps to Contribute
1. Fork the repository.
2. Create a branch for your feature or bug fix.
3. Write your code and tests.
4. Submit a pull request.
## Contributor License Agreement (CLA)
Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide When you submit a pull request, a CLA bot will automatically determine whether you need to provide
@ -12,11 +20,12 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
### How to Contribute ## Getting Started
To start contributing, refer to the [Running Tests and Checks](#running-tests-and-checks) section.
## Issues and PRs
You can help by looking at issues or helping review PRs. Any issue or PR is welcome, but we have also marked some as 'open for contribution' and 'open for reviewing' to help facilitate community contributions. These are of course just suggestions and you are welcome to contribute in any way you like. You can help by looking at issues or helping review PRs. Any issue or PR is welcome, but we have also marked some as 'open for contribution' and 'open for reviewing' to help facilitate community contributions. These are of course just suggestions and you are welcome to contribute in any way you like.
<div align="center"> <div align="center">
| | All | Especially Needs Help from Community | | | All | Especially Needs Help from Community |
@ -43,6 +52,13 @@ You can help by looking at issues or helping review PRs. Any issue or PR is welc
- Run pre-commit checks before submitting a PR: `pre-commit run --all-files` - Run pre-commit checks before submitting a PR: `pre-commit run --all-files`
- Run pre-commit checks before submitting a PR: `pre-commit run --all-files`
### How to Contribute
You can help by looking at issues or helping review PRs. Any issue or PR is welcome, but we have also marked some as 'open for contribution' and 'open for reviewing' to help facilitate community contributions. These are ofcourse just suggestions and you are welcome to contribute in any way you like.
## Trademarks ## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft