Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 1.85 KB
Raw

Contributing to promkit

We welcome contributions to "promkit" and greatly appreciate your help in making this project even better. Here's a quick guide to get you started.

How to Contribute

  1. Fork the Repository: Click the "Fork" button at the top right of the promkit repository to create a copy of the project in your GitHub account.

  2. Clone the Repository: On your local machine, open a terminal and run the following command, replacing <your_username> with your GitHub username:

git clone https://github.com/<your_username>/promkit.git
  1. Create a Branch: Before making any changes, create a new branch for your work:
git checkout -b your-branch-name

  1. Make Changes: Make your desired code changes, bug fixes, or feature additions.

  2. Commit Your Changes: Commit your changes with a clear and concise message explaining the purpose of your contribution:

git commit -m "Your commit message here"
  1. Push to Your Fork: Push your changes to your forked repository on GitHub:
git push origin your-branch-name

  1. Create a Pull Request (PR): Open the promkit Pull Request page and click the "New Pull Request" button. Compare and create your PR by following the prompts.

  2. Review and Discuss: Your PR will be reviewed by project maintainers, who may provide feedback or request further changes. Be prepared for discussion and updates.

  3. Merging: Once your PR is approved and passes any necessary tests, a project maintainer will merge it into the main repository.

Code of Conduct

Please adhere to our Code of Conduct when participating in this project. We aim to create a respectful and inclusive community for all contributors.

Thank you for considering contributing to "promkit"!