Skip to content

Commit f2cfc40

Browse files
committed
Adding conribution instructions for quickstart workflow
Signed-off-by: MD Ashique <[email protected]>
1 parent de038bc commit f2cfc40

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

CONTRIBUTING.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,62 @@ git commit --amend --no-edit --signoff
107107
git push --force-with-lease <remote-name> <branch-name>
108108
```
109109

110+
#### How to Contribute to GitHub Workflows
111+
112+
To contribute to the GitHub workflows in this repository, please follow these steps:
113+
114+
1. Identify a specific area where you would like to contribute, such as adding a new workflow or improving an existing one.
115+
2. Fork the repository.
116+
3. Clone the repository to your local machine.
117+
4. Create a new branch for your changes: `git checkout -b <branch-name>`
118+
5. Make your changes to the GitHub workflows.
119+
6. Test your changes to ensure that they work as expected.
120+
7. Document any new workflows that you add or changes that you make to existing ones.
121+
8. Commit your changes: `git commit -am 'Add some feature'`
122+
9. Push your changes to your fork: `git push origin <branch-name>`
123+
10. Submit a pull request to the main repository.
124+
125+
## Running GitHub Workflows in Your Personal Fork
126+
127+
To run the GitHub workflows in your personal fork of this repository, you will need to set up some environment variables and secrets. These settings are necessary for the workflows to run successfully.
128+
129+
### Required Environment Variables
130+
131+
The following environment variables are required for the GitHub workflows in this repository:
132+
133+
- `GITHUB_TOKEN`: This is a personal access token that allows the workflow to authenticate with GitHub. You can create a personal access token by following [these instructions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
134+
135+
### Required Secrets
136+
137+
The following secrets are required for the GitHub workflows in this repository:
138+
139+
- `DOCKER_USERNAME`: This is the username for your Docker Hub account. You can create a Docker Hub account by following [these instructions](https://hub.docker.com/signup).
140+
- `DOCKER_PASSWORD`: This is the password for your Docker Hub account.
141+
142+
### Setting Up Environment Variables and Secrets
143+
144+
To set up the required environment variables and secrets in your personal fork of this repository, follow these steps:
145+
146+
1. Navigate to your personal fork of this repository on GitHub.
147+
2. Click on the "Settings" tab.
148+
3. Click on the "Secrets" menu item.
149+
4. Click on the "New repository secret" button.
150+
5. Enter the name of the secret (e.g., `DOCKER_USERNAME`).
151+
6. Enter the value of the secret (e.g., your Docker Hub username).
152+
7. Repeat steps 5-6 for the `DOCKER_PASSWORD` secret.
153+
8. Navigate to the "Actions" tab in your personal fork of the repository.
154+
9. Enable GitHub Actions for your fork by clicking on the "I understand my workflows, go ahead and enable them" button.
155+
10. Update the env section of the GitHub workflows to include your own values for the required environment variables and secrets.
156+
157+
### Workflow permissions
158+
1. Navigate to your personal fork of this repository on GitHub.
159+
2. Click on the "Settings" tab.
160+
3. Click on the "Actions" menu item and select General.
161+
4. Scroll down to Workflow permissions section and select `Read and write permissions`
162+
163+
164+
That's it! With the required environment variables and secrets set up in your personal fork, you should be able to run the GitHub workflows successfully.
165+
110166
### Use of Third-party code
111167

112168
- All third-party code must be placed in the `vendor/` folder.

0 commit comments

Comments
 (0)