Skip to content

fix(docs): remove misleading manual edit step in CONTRIBUTING.md #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
josephkabba wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(docs): remove misleading manual edit step in CONTRIBUTING.md #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,23 +78,20 @@ You can add your card as an HTML file in the contributors directory. Create a fi
</style>

```
## Add your card to contributors list
## View your changes in a web browser

Add the name of the file you created to `scripts/contributors.js` file.
You can see your changes by opening `index.html` in a web browser. To do this, first run the generate cards script to update the contributors list:

`scripts/contributors.js`
```js
const contributorFiles = [
"btrust-builders.html",
"your-github-username.html", // add your file name here
];
```bash
bash scripts/generate-cards.sh
```

## View your changes in a web browser
Then open `index.html` in your browser. You should be able to see the new card you added in the previous step.

You can see your changes by opening `index.html` in a web browser. You should be able to see the new card you added in the previous steps.
You can continue making changes to your card, re-run the script, and refresh the web browser tab to see those changes.

You can continue making changes to your card and refresh the web browser tab to see those changes.
> [!NOTE]
> You don't need to commit the generated `scripts/contributors.js` file. The CI pipeline runs this script automatically when your pull request is submitted.

## Commit your changes

Expand Down