mirror of
https://github.com/di-sukharev/opencommit.git
synced 2026-01-15 00:28:30 -05:00
18d25672d7
This change emphasizes that pull requests should be made to the `dev` branch, not the `master` branch, to ensure proper workflow.
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
# Contribution Guidelines
|
|
|
|
Thanks for considering contributing to the project.
|
|
|
|
## How to contribute
|
|
|
|
1. Fork the project repository on GitHub.
|
|
2. Clone your forked repository locally.
|
|
3. Create a new branch for your changes.
|
|
4. Make your changes and commit them with descriptive commit messages.
|
|
5. Push your changes to your forked repository.
|
|
6. Create a pull request from your branch to the `dev` branch. Not `master` branch, PR to `dev` branch, please.
|
|
|
|
## Getting started
|
|
|
|
To get started, follow these steps:
|
|
|
|
1. Clone the project repository locally.
|
|
2. Install dependencies with `npm install`.
|
|
3. Run the project with `npm run dev`.
|
|
4. See [issues](https://github.com/di-sukharev/open-commit/issues) or [TODO.md](../TODO.md) to help the project.
|
|
|
|
## Commit message guidelines
|
|
|
|
Use the library to generate commits, stage the files and run `npm run dev` :)
|
|
|
|
## Reporting issues
|
|
|
|
If you encounter any issues while using the project, please report them on the GitHub issue tracker. When reporting issues, please include as much information as possible, such as steps to reproduce the issue, expected behavior, and actual behavior.
|
|
|
|
## Contacts
|
|
|
|
If you have any questions about contributing to the project, please contact by [creating an issue](https://github.com/di-sukharev/open-commit/issues) on the GitHub issue tracker.
|
|
|
|
## License
|
|
|
|
By contributing to this project, you agree that your contributions will be licensed under the MIT license, as specified in the `LICENSE` file in the root of the project.
|