Skip to content

Commit 6b18d7b

Browse files
authored
Update CONTRIBUTING.md
1 parent c9ee6a2 commit 6b18d7b

File tree

1 file changed

+96
-1
lines changed

1 file changed

+96
-1
lines changed

.github/CONTRIBUTING.md

+96-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,96 @@
1-
test contributing
1+
# Contributing to Streamlit-Analytics
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Develop with GitHub
12+
13+
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## We Use GitHub Flow
16+
17+
All code changes happen through pull requests, so we suggest you familiarize yourself with [GitHub Flow](https://guides.github.com/introduction/flow/). Pull requests are the best way to propose changes to the codebase (we use [GitHub Flow](https://guides.github.com/introduction/flow/)). We actively welcome your pull requests:
18+
19+
1. Fork the repo and create your branch from `main`.
20+
2. Make sure your code lints.
21+
3. Issue that pull request!
22+
23+
## Any contributions you make will be under the same license as the project
24+
25+
In short, when you submit code changes, your submissions are understood to be under the same [license](LICENSE.md) that covers the project. Feel free to contact the maintainers if that's a concern.
26+
27+
## Report bugs using Github's [issues](https://github.com/jrieke/streamlit-analytics/issues)
28+
29+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/jrieke/streamlit-analytics/issues/new); it's that easy!
30+
31+
**Great Bug Reports** tend to have:
32+
33+
- A quick summary and/or background
34+
- Steps to reproduce
35+
- Be specific!
36+
- Give sample code if you can.
37+
- What you expected would happen
38+
- What actually happens
39+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
40+
41+
## Use a Consistent Coding Style
42+
43+
TO BE DETERMINED
44+
45+
## License
46+
47+
By contributing, you agree that your contributions will be licensed under its [License](LICENSE.md).
48+
49+
## Guide to setting up a testing/dev environment
50+
1. navigate to the directory you want to clone the repo into
51+
```
52+
cd path_to_your_project_location
53+
```
54+
55+
2. clone the repo
56+
```
57+
git clone https://github.com/jrieke/streamlit-analytics.git
58+
```
59+
60+
3. navigate into the repo
61+
```
62+
cd streamlit-analytics
63+
```
64+
65+
4. create a new branch
66+
```
67+
git checkout -b name_of_your_new_branch
68+
```
69+
70+
5. create a venv
71+
```
72+
python3 -m venv env
73+
```
74+
75+
6. activate the virtual environment
76+
```
77+
Linux: source env/bin/activate
78+
Windows: env\Scripts\activate
79+
```
80+
Note: make sure to restart any terminals and make sure the word (env) is in front of the terminal prompt
81+
82+
7. install the requirements
83+
```
84+
pip install -r examples/requirements.txt
85+
```
86+
87+
8. run the minimal.py file
88+
```
89+
streamlit run examples/minimal.py
90+
```
91+
92+
---
93+
At this point you should see a basic streamlit app and can begin testing and changes you may wish to contrubute in a PR
94+
95+
Please note that to accurately test any changes, need to take into account that the streamlit app is cached. To clear the cache, you can either restart the streamlit app or add the following to the top of your app uses a virtual environment:
96+
As

0 commit comments

Comments
 (0)