Skip to content

Commit d89235a

Browse files
authored
Merge pull request #4 from dynata-bradley/patch-3
Create CONTRIBUTING.md (part of POP-2281)
2 parents 19f255f + 5bfb6f9 commit d89235a

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
### Contributing to python-demandapi-client
2+
3+
This is an InnerSource python project. It is the work of someone who thought it might benefit someone else in the company as well.
4+
5+
### Maintainers
6+
7+
This repository is maintained by
8+
9+
1. [Ridley Larsen](@RidleyLarsen)
10+
11+
## Contributing Code
12+
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+
15+
## Linting
16+
17+
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.
18+
19+
Read more [here](http://flake8.pycqa.org/en/latest/)
20+
21+
## Testing
22+
23+
## Filing Issues
24+
25+
Please use the [GitHub Issues](https://github.com/researchnow/python-demandapi-client/issues/new) to file an issue.
26+
27+
Thats it.

0 commit comments

Comments
 (0)