Skip to content
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.

Sign up for GitHub

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 4 commits into from
Sep 13, 2016
Merged

Add Contributing guide #90

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5ea00d8
Add basic template for Contributing guide
sahildua2305 Sep 1, 2016
fa061fa
Add contributing guidelines - basic
sahildua2305 Sep 1, 2016
6ef185e
Add testing and submitting changes sections information to contributi…
sahildua2305 Sep 10, 2016
1acd824
Remove kinto.ini file (added by mistake in last commit)
sahildua2305 Sep 12, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is best to clone from the Kinto/kinto-http.py repository and then add your remote:

git clone git@github.com:Kinto/kinto-http.py.git
git remote add {your_name} git@github.com:{your_name}/kinto-http.py.git

Then you can:

git checkout master
git pull origin master
git checkout -b issue_number-bug-title
git push -u {your_name} issue_number-bug-title

- Clone your fork locally:

```bash
git clone git@github.com:your_name_here/kinto-http.py.git
```


## Testing

Copy link
Member

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


## Submitting Changes

Copy link
Member

@Natim Natim Sep 6, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

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.