Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/lacion/forge/issues.
If you are reporting a bug, please include:
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
forge could always use more documentation, whether as part of the official forge docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/lacion/forge/issues.
If you are proposing a feature:
Ready to contribute? Here’s how to set up forge for local development.
Fork the forge repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:lacion/forge.git
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
I strongly encourage the use of gitflow
Create a branch for local development:
$ git flow feature start name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you’re done making changes, check that your changes pass flake8 and the tests:
$ flake8 --max-line-length=120 forge tests
$ python setup.py test
To get flake8 , just pip install it into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
the only flake8 rule were changing is the line length up to a 120 chars –max-line-length=120
Before you submit a pull request, check that it meets these guidelines: