Update contribution instruction
This commit is contained in:
parent
9b8b80b0ec
commit
5132b1d013
@ -60,10 +60,13 @@ Your goal is to...
|
|||||||
1. **Fork this repository**
|
1. **Fork this repository**
|
||||||
2. **Create a new branch** for your contribution
|
2. **Create a new branch** for your contribution
|
||||||
3. **Add your instruction or prompt file** following the guidelines above
|
3. **Add your instruction or prompt file** following the guidelines above
|
||||||
4. **Run the update script** (optional): `node update-readme.js` to update the README with your new file
|
4. **Run the update script** (optional): `node update-readme.js` to update the `README` with your new file
|
||||||
- A GitHub Actions workflow will verify that this step was performed correctly
|
- A GitHub Actions workflow will verify that this step was performed correctly
|
||||||
- If the README.md would be modified by running the script, the PR check will fail with a comment showing the required changes
|
- If the `README.md` would be modified by running the script, the PR check will fail with a comment showing the required changes
|
||||||
5. **Submit a pull request** with:
|
5. **Run the update script** (optional): `node update-metadata.js` to update the `metadata.json` with your new file
|
||||||
|
- A GitHub Actions workflow will verify that this step was performed correctly
|
||||||
|
- If the `metadata.json` would be modified by running the script, the PR check will fail with a comment showing the required changes
|
||||||
|
6. **Submit a pull request** with:
|
||||||
- A clear title describing your contribution
|
- A clear title describing your contribution
|
||||||
- A brief description of what your instruction/prompt does
|
- A brief description of what your instruction/prompt does
|
||||||
- Any relevant context or usage notes
|
- Any relevant context or usage notes
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user