-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Contributing guide #90
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
5ea00d8
Add basic template for Contributing guide
sahildua2305 fa061fa
Add contributing guidelines - basic
sahildua2305 6ef185e
Add testing and submitting changes sections information to contributi…
sahildua2305 1acd824
Remove kinto.ini file (added by mistake in last commit)
sahildua2305 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
How to contribute | ||
================= | ||
|
||
Thanks for your interest in contributing to Kinto! | ||
|
||
## Reporting Bugs | ||
|
||
Report bugs at https://github.com/Kinto/kinto-http.py/issues/new | ||
|
||
If you are reporting a bug, please include: | ||
|
||
- Any details about your local setup that might be helpful in troubleshooting. | ||
- Detailed steps to reproduce the bug or even a PR with a failing tests if you can. | ||
|
||
|
||
## Ready to contribute? | ||
|
||
### System Requirements | ||
|
||
Depending on the platform and chosen configuration, some libraries or extra services are required. | ||
|
||
The following commands will install necessary tools for cryptography and Python packaging like Virtualenv. | ||
|
||
#### Linux | ||
On Debian / Ubuntu based systems: | ||
|
||
```bash | ||
apt-get install libffi-dev libssl-dev python-dev python-virtualenv | ||
``` | ||
|
||
#### OS X | ||
Assuming [brew](http://brew.sh/) is installed: | ||
|
||
```bash | ||
brew install libffi openssl pkg-config python | ||
|
||
pip install virtualenv | ||
``` | ||
|
||
### Getting Started | ||
|
||
- Fork the repo on GitHub and clone locally: | ||
|
||
```bash | ||
git clone git@github.com:Kinto/kinto-http.py.git | ||
git remote add {your_name} git@github.com:{your_name}/kinto-http.py.git | ||
``` | ||
|
||
## Testing | ||
|
||
- `make tests-once` to run the test with the current venv. | ||
- `make tests` to run all the tests (with Py2 and Py3, flake8 and functional tests) | ||
|
||
You may need to use `make run-kinto` before running the functional tests. | ||
If you want to run the functional tests only, you can use `make functional`. | ||
|
||
## Submitting Changes | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Then you can create a Pull-Request. You will be able to update your pull-request by adding commit in your branch. |
||
```bash | ||
git checkout master | ||
git pull origin master | ||
git checkout -b issue_number-bug-title | ||
git commit # Your changes | ||
git push -u {your_name} issue_number-bug-title | ||
``` | ||
|
||
Then you can create a Pull-Request. | ||
Please create your pull-request as soon as you have one commit even if it is only a failing tests. This will allow us to help and give guidance. | ||
|
||
You will be able to update your pull-request by adding commit in your branch. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make tests-once
to run the test with the current venv.make tests
to run all the tests (with Py2 and Py3, flake8 and functional tests)You may need to use
make run-kinto
before running the functional tests.If you want to run the functional tests only, you can use
make functional