Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

67 lines (45 loc) · 2.18 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

See the GitHub guidelines before get started contributing to this project.

Get started!

Here is how to set up the readme-page repository for local development.

  1. Fork the readme-page repository on GitHub.

  2. Clone your repository locally.

$ git clone git@github.com:fernandojunior/readme-page.git
  1. Configure your repository for local development with virtualenv and pip.
$ cd readme-page/
$ virtualenv env && source env/bin/activate
$ pip install -r requirements/dev.txt
  1. Create a branch for local development.
$ git checkout -b name-of-your-fix-or-feature

  1. Make changes in your repository files locally.

  2. When you are done making changes, check that your changes pass flake8, pytest, tox and coverage.py:

$ flake8
$ py.test
$ tox
$ coverage run -m py.test && coverage report --show-missing

You can run all these commands automatically with make all. Run make help for more information.

  1. Stage the files for the first commit to your repository.
$ git add .
# Adds the files in the local repository and stages them for commit.
# To unstage a file, use 'git reset HEAD YOUR-FILE'.
  1. Commit the files that you've staged in your local repository.
$ git commit -m 'Your detailed description of your changes.'
# Commits the tracked changes and prepares them to be pushed to a remote repository.
  1. Push the changes in your branch created previously.
$ git push origin name-of-your-fix-or-feature
  1. Submit a pull request through the GitHub.