sigit/sigit.io
7
2
Fork 0
Code Issues 41 Pull Requests 3 Actions Packages Projects 1 Releases Wiki Activity

chore: testing guidance in contributing.md
All checks were successful
Release to Staging / build_and_release (push) Successful in 1m40s
Details

Browse Source
This commit is contained in:
b 2025-01-07 20:20:22 +00:00
parent 60b3a28435
commit 736dafce94
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
contributing.md
View File

@ -6,19 +6,19 @@ Welcome to Sigit! We are thrilled that you are interested in contributing to thi
### Reporting Bugs ### Reporting Bugs
If you encounter a bug while using Sigit, please [open an issue](https://git.sigit.io/g/web/issues/new) on this repository. Provide as much detail as possible, including steps to reproduce the bug. If you encounter a bug while using Sigit, please [open an issue](https://git.nostrdev.com/sigit/sigit.io/issues/new) on this repository. Provide as much detail as possible, including steps to reproduce the bug.
### Suggesting Enhancements ### Suggesting Enhancements
If you have an idea for how to improve Sigit, we would love to hear from you! [Open an issue](https://git.sigit.io/g/web/issues/new) to suggest an enhancement. If you have an idea for how to improve Sigit, we would love to hear from you! [Open an issue](https://git.nostrdev.com/sigit/sigit.io/issues/new) to suggest an enhancement.
### Pull Requests ### Pull Requests
We welcome pull requests from contributors! To contribute code changes: We welcome pull requests from contributors! To contribute code changes:
1. Fork the repository and create your branch from `main`. 1. Fork the repository and create your branch from `staging`.
2. Make your changes and ensure they pass any existing tests. 2. Make your changes and ensure they pass any existing tests.
3. Write meaningful commit messages. 3. Write meaningful commit messages (conventional commit standard)
4. Submit a pull request, describing your changes in detail and referencing any related issues. 4. Submit a pull request, describing your changes in detail and referencing any related issues.
## Development Setup ## Development Setup
@ -35,4 +35,14 @@ All contributions, including pull requests, undergo code review. Code review ens
## Contact ## Contact
If you have questions or need further assistance, you can reach out to [maintainer's email]. If you have questions or need further assistance, you can reach out to `npub1d0csynrrxcynkcedktdzrdj6gnras2psg48mf46kxjazs8skrjgq9uzhlq`
## Testing
The following items should be tested with each release:
- Create a SIGit with at least 3 signers
- Create a SIGit where the creator is not the first signer
- Create a SIGit where one co-signer has no marks
- Create a SIGit using a file other than a PDF
- Use several login mechanisms, browsers, operating systems whilst testing