27 lines
1.3 KiB
Markdown
27 lines
1.3 KiB
Markdown
## Contributing
|
|
|
|
Note we have a [code of conduct](./CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
|
|
|
|
Ensure you've read through the documentation so you understand the core concepts and the working of the project.
|
|
|
|
### How to report a bug
|
|
|
|
1. Search the [issues](https://github.com/vedantmgoyal9/winget-releaser/issues) to see if the bug has already been reported by someone else, and/or if it has been already fixed in the latest version.
|
|
2. If you don't find anything, create a new issue with the following information:
|
|
- A clear and concise description of what the bug is.
|
|
- Steps to reproduce the bug.
|
|
- Expected behavior.
|
|
- Logs or screenshots (if applicable).
|
|
- Version of the action you're using.
|
|
- Any other information that you think might be useful.
|
|
|
|
### How to contribute to the project
|
|
|
|
1. Fork the repository
|
|
2. Create a new branch to work on: `git checkout -b <some-branch-name>`
|
|
3. Commit changes by using: `git commit -m 'feat: <short description about the feature>'`
|
|
4. Push branch to your fork: `git push origin <some-branch-name>`
|
|
5. Finally, create a pull request to the repository.
|
|
6. Wait for the PR to be reviewed and merged by the maintainers.
|
|
7. Congratulations! Your name will be shown on the README.md file :tada:
|