Skip to content

Commit eae4b12

Browse files
committed
updating conributing for InnerSourcing POP-2281
1 parent 0516f2e commit eae4b12

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,36 @@ This is an InnerSource python project. It is the work of someone who thought it
77
This repository is maintained by
88

99
1. [Ridley Larsen](@RidleyLarsen)
10+
1. [Bradley Wogsland](@wogsland)
1011

11-
## Contributing Code
12+
### Community Guidelines
1213

13-
The best place to start is by looking at the [Samplify Integration board](https://app.asana.com/0/1143497512179452/board), which is for the initial build. If you decide to take on a task make sure to assign it to yourself so we don't duplicate work. A good PR completely resolves the associated Asana issue, passes or python linting, and includes test coverage for your new code. This Github repository is integrated with CircleCI, so a PR cannot be accepted that has merge conflicts, fails to pass linting or tests, or lowers the repository's test coverage. Additionally your PR should include a high level description of your or reviewers will be peppering you with questions, if this is something someone might have a question about in the future then go ahead and add this information to the [docs](docs). Approval of the maintainer is required merge a PR into `dev`, which is where all PRs go.
14+
This project follows the [Github Community Guidlines](https://help.github.com/en/github/site-policy/github-community-guidelines). Please feel free to contact the maintainers with any issues.
1415

15-
## Linting
16+
### Contributing Code
17+
18+
The best place to start is by looking at the [GitHub Issues](https://github.com/dynata/python-demandapi-client/issues) to see what needs to be done. If you decide to take on a task make sure to comment on it so work isn't duplicated. A good PR completely resolves the associated issue, passes python linting, and includes test coverage for your new code. This Github repository is integrated with CircleCI, so a PR cannot be accepted that has merge conflicts, fails to pass linting or tests, or lowers the repository's test coverage. Additionally your PR should include a high level description of your work or reviewers will be peppering you with questions. Approval of the maintainer is required merge a PR into `dev`, which is where all PRs go.
19+
20+
### Linting
1621

1722
Linting software is strongly recommended to improve code quality and maintain readability in Python projects. Python's official linting package is called pycodestyle, but another useful linting package is called flake8. Flake8 runs three different linters on your code, including pycodestyle, and a package called PyFlakes that checks for things like unused imports.
1823

1924
Read more [here](http://flake8.pycqa.org/en/latest/)
2025

21-
## Testing
26+
### Testing
27+
28+
To run the tests,
29+
30+
virtualenv venv
31+
. venv/bin/activate
32+
pip install -r requirements.txt
33+
pytest tests
34+
deactivate
35+
36+
to run the tests for this project.
2237

23-
## Filing Issues
38+
### Filing Issues
2439

25-
Please use the [GitHub Issues](https://github.com/researchnow/python-demandapi-client/issues/new) to file an issue.
40+
Please use the [GitHub Issues](https://github.com/dynata/python-demandapi-client/issues/new) to file an issue.
2641

2742
Thats it.

0 commit comments

Comments
 (0)