Skip to content

Commit 558b835

Browse files
committed
Update contribution guidelines for branching and workflow
1 parent d15b25f commit 558b835

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,16 @@ Thank you for your interest in contributing! FEAScript is in early development,
7979
6. **Branching & Workflow:**
8080
To contribute a new feature or fix:
8181

82-
- Do not commit directly to `main` or `dev`.
83-
- Instead, start your work in a feature branch based on the `dev` branch.
82+
- Do not commit directly to `main`.
83+
- Instead, create a short‑lived branch:
84+
- `feature/<topic>` for new functionality
85+
- `fix/<issue>` for bug fixes
8486

85-
**If you are not a member of the repository (e.g., an external contributor), you must first [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).** Make your changes in your fork, then submit a Pull Request from your fork's feature branch into the `dev` branch.
87+
External contributors:
88+
89+
1. Fork the repo.
90+
2. Branch from `main` in your fork.
91+
3. Push and open a PR from your fork’s branch into `main`.
8692

8793
7. **Local Testing:**
8894
Before submitting a pull request, test your modifications by running the FEAScript library from a local directory. For example, you can load the library in your HTML file as follows:

0 commit comments

Comments
 (0)