Debian Codegraph @

docs/contributing.rst

raw
1 Contributing to Flask-Dance
2 ===========================
3
4 If you want to contribute to Flask-Dance, we would love the help!
5
6 Providers
7 ---------
8
9 The simplest way to contribute to Flask-Dance is by adding new
10 pre-set OAuth providers. Check out the ``contrib`` directory
11 to see how to do that. Don't forget to check the README file
12 to see the requirements for getting your contribution merged!
13
14 Documentation
15 -------------
16
17 Contributing to the documentation is probably the best thing you can do
18 for Flask-Dance! OAuth is complicated, and the people using Flask-Dance
19 don't want to understand all the details. Writing clear, comprehensive
20 documentation will make everyone's lives easier.
21
22 Code
23 ----
24
25 The general checklist for all code contributions is:
26
27 - Code
28 - Tests
29 - Docs
30 - Changelog
31
32 We strive for roughly 95% test coverage. Not every line needs to be tested,
33 but there should be a clear justification for untested lines in your pull
34 request. You can use `tox`_ to run the unit tests on multiple Python
35 versions locally, if you want.
36
37 Documenting changes is very important! Particularly when adding new features
38 or changing existing ones, if it isn't documented, no one will know that
39 it exists.
40
41 The changelog is important to people who are using an old version of
42 Flask-Dance, and want to upgrade to a more recent version.
43 In your pull request, add a bullet point to the "unreleased" section
44 of the changelog, describing what your change does.
45
46 Do not modify the version number in your pull request. The maintainer
47 will change the version number when releasing a new version of
48 Flask-Dance.
49
50 Don't be afraid to ask for help! If you have a code change you'd like to make,
51 and you don't know how to write the tests or the docs, you're welcome to
52 open a pull request anyway and ask for help with completing the remaining
53 steps. (Just don't expect your pull request to be merged until those steps
54 are complete!)
55
56 .. _tox: https://tox.readthedocs.io/