Skip to content

Commit 9a0f114

Browse files
contributing updated
1 parent 2a9573d commit 9a0f114

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,23 @@ We designed PICA with a modular architecture specifically to make this process s
1212

1313
Beyond practical utility, making PICA open source is a statement of scientific integrity. Unlike proprietary "black box" software that obscures experimental methodology, PICA ensures complete transparency. By accessing the full source code, researchers can audit the exact SCPI command sequences, timing delays, and data handling procedures used in an experiment. This methodological clarity is essential for rigorous validation and reproducibility in modern experimental science.
1414

15-
## Where do I go from here?
15+
## How to Report Bugs
1616

17-
If you've noticed a bug or have a feature request, [make one](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/issues/new)! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code.
17+
If you encounter a bug, please help us by reporting it. A well-reported bug significantly speeds up the resolution process. Before opening a new issue, please check if a similar issue already exists.
18+
19+
When reporting a bug, please include as much detail as possible:
20+
21+
* **Steps to reproduce:** Clearly describe how to trigger the bug.
22+
* **Expected behavior:** What did you expect to happen?
23+
* **Actual behavior:** What actually happened?
24+
* **PICA version:** Specify the version of PICA you are using.
25+
* **Operating system:** Your OS and version (e.g., Windows 10, Ubuntu 20.04).
26+
* **Hardware setup:** Briefly describe your instrument setup if relevant.
27+
* **Error messages/logs:** Include any relevant error messages or console output.
28+
29+
You can use the [bug report issue template](https://github.com/prathameshnium/PICA-Python-Instrument-Control-and-Automation/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=%5BBUG%5D) to ensure you provide all necessary information.
30+
31+
## How to get in touch
1832

1933
### Fork & create a branch
2034

@@ -30,12 +44,23 @@ git checkout -b feature/add-new-instrument
3044

3145
Make sure you're running the test suite locally. It's a good idea to do this before you start making changes to ensure that everything is working correctly.
3246

47+
### Coding Style Guide
48+
49+
PICA adheres to [PEP 8](https://www.python.org/dev/peps/pep-0008/) for Python code style. Please ensure your contributions follow these guidelines. You can use tools like `flake8` or `black` to help format your code.
50+
3351
### Implement your fix or feature
3452

3553
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first:
3654

3755
### Make a Pull Request
3856

57+
Once you've made your changes and tested them locally, you're ready to create a Pull Request (PR). A good PR makes it easy for maintainers to understand and review your changes. Please include:
58+
59+
* **A clear and concise title:** Summarize the main purpose of your PR.
60+
* **Detailed description:** Explain the problem your PR solves, how you solved it, and any significant design decisions.
61+
* **References to issues:** Link to any related issues (e.g., "Fixes #123" or "Closes #456").
62+
* **Testing done:** Describe how you tested your changes.
63+
3964
At this point, you should switch back to your main branch and make sure it's up to date with the latest upstream version of PICA.
4065

4166
```sh

0 commit comments

Comments
 (0)