Skip to content

Commit 44d60dd

Browse files
Update Readme.md (#132)
1 parent b2b659a commit 44d60dd

File tree

1 file changed

+74
-7
lines changed

1 file changed

+74
-7
lines changed

Diff for: collaborate/Readme.md

+74-7
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,85 @@
11
Collaborate with PSLab!
22
=======================
33

4-
Pocket Science Lab Experiments
5-
------------------------------
4+
Welcome to the PSLab (Pocket Science Lab) collaboration guide. This document will help you get started with contributing to the PSLab repository.
65

7-
The PSLab repository allows anyone to contribute. One way is to create
8-
experiments for [Pocket Science Lab.](https://github.com/fossasia?q=pslab).
6+
## Pocket Science Lab Experiments
97

10-
See also the template `tutorials/template.md`.
8+
One of the best ways to contribute to PSLab is by creating experiments. These experiments help users explore the capabilities of the Pocket Science Lab and learn about various scientific concepts.
119

12-
## Instructions
10+
### Creating an Experiment
1311

1412
1. Fork the repository
15-
2. Create and/or edit files using your editor
13+
2. Create and/or edit files using your preferred editor
14+
3. Follow the structure outlined in `tutorials/template.md`
15+
16+
## File Formats
17+
18+
We primarily use Markdown (.md) for our documentation. However, please note:
19+
20+
- The main document headlines (typically the first one at the top of the file) should be written in reStructuredText (ReST) format for compatibility with Sphinx documentation.
21+
- The rest of the content should be in Markdown format.
1622

1723
For convenience, you can use [notex](https://www.notex.ch), an
1824
[open-source](https://github.com/hsk81/notex-v2.0) ReST editor.
25+
26+
## Editing Tools
27+
28+
While you can use any text editor of your choice, we recommend using open-source Markdown editors for convenience. Some options include:
29+
30+
- Visual Studio Code with Markdown extensions
31+
- Typora
32+
- MarkText
33+
- Joplin
34+
35+
These editors provide live previews and other helpful features for writing Markdown.
36+
37+
## How to Contribute
38+
39+
### Reporting Bugs
40+
41+
- Before submitting a bug report, please check our issue tracker to see if the bug has already been reported.
42+
- If you're unable to find an open issue addressing the problem, open a new one.
43+
- When you are creating a bug report, please include as many details as possible:
44+
- Use a clear and descriptive title
45+
- Describe the exact steps which reproduce the problem
46+
- Provide specific examples to demonstrate the steps
47+
- Describe the behavior you observed after following the steps
48+
- Explain which behavior you expected to see instead and why
49+
- Include screenshots if possible
50+
- Include your environment details (OS, browser version, etc.)
51+
52+
### Suggesting Enhancements
53+
54+
- Use a clear and descriptive title for the issue to identify the suggestion.
55+
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
56+
- Provide specific examples to demonstrate the steps or point out the part of PSLab where the suggestion is related to.
57+
- Describe the current behavior and explain which behavior you expected to see instead and why.
58+
- Explain why this enhancement would be useful to most PSLab users.
59+
- List some other projects or applications where this enhancement exists, if applicable.
60+
61+
### Your First Code Contribution
62+
63+
- Start with our list of beginner-friendly issues labeled as "good first issue" in our issue tracker.
64+
- If you're just getting started with PSLab, consider working on documentation improvements or adding new experiments.
65+
- Don't hesitate to ask for help in our community channels if you're stuck.
66+
67+
### Pull Requests
68+
69+
- Fill in the required template when creating your pull request.
70+
- Do not include issue numbers in the PR title.
71+
- Follow our coding standards and style guides.
72+
- Include appropriate test cases if you're adding new functionality.
73+
- Ensure all tests pass before submitting your pull request.
74+
- Update the documentation, if relevant to your changes.
75+
76+
## Submitting Your Contribution
77+
78+
Once you've created or edited your files:
79+
80+
1. Commit your changes to your forked repository
81+
2. Create a pull request to the main PSLab repository
82+
3. Wait for review and feedback from the maintainers
83+
84+
Thank you for contributing to PSLab! Your efforts help make science more accessible to everyone.
85+

0 commit comments

Comments
 (0)