Comments (12)
This should wait till #100 and #99 are taken care of. See #98.
from axelrod.
and meaningful variable names (please)!!
from axelrod.
Yup, great will add that also.
I'm thinking of making pep8 be part of the testing suite on Travis... Any reason not to? (330 things fail pep8 at the moment)
from axelrod.
I hate to play the gadly again, but there is no real reason for this and it would be a distraction. Do you really need code that is squeaky clean? Style guides are just that, guides. Not rules. See this part of PEP8 itself:
https://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
from axelrod.
I tend to agree with @langner
Style guidelines are nice to have, but can end up causing more problems than they solve.
For example, some of the PEP8 errors I've fixed along the way have been simply that a line is more than 79 characters. It simply isn't worth the effort to go through the codebase to find and correct them.
from axelrod.
To be clear - I think the contribution guidelines should include PEP, but there's no point including compliance as part of the test suite.
from axelrod.
Cool, that sounds good to me, will leave the PEP testing out of Travis but
will include something about PEP in the guidelines. I'll throw them on a
separate branch (might get to it today) and ping you guys to see if you
think what I've written is good :)
On Mon, 9 Mar 2015 15:01 Owen Campbell [email protected] wrote:
I tend to agree with @langner https://github.com/langner
Style guidelines are nice to have, but can end up causing more problems
than they solve.For example, some of the PEP8 errors I've fixed along the way have been
simply that a line is more than 79 characters. It simply isn't worth the
effort to go through the codebase to find and correct them.β
Reply to this email directly or view it on GitHub
https://github.com/drvinceknight/Axelrod/issues/101#issuecomment-77869555
.
from axelrod.
Hey @langner and @meatballs , I've just pushed this as contribution guidelines: https://github.com/drvinceknight/Axelrod/blob/c-guidelines/docs/contributing.rst
Let me know what you think. If I don't hear anything I'll assume it's ok (kind of a guidelines/tutorial ish thing).
Once that's merged in to master I'm going to try and go to down on documentation... (by the way: I'm writing this using wifi on a plane! I can't get over how cool that is... I'm in the future!)
from axelrod.
I skimmed over it and it seems fine.
from axelrod.
π
from axelrod.
Sorry - been down with a dose of food poisoning! Looks good to me too.
from axelrod.
Cool, thanks both. That is now merged in to master.
from axelrod.
Related Issues (20)
- Reorganisation of documentation. HOT 3
- Reorganisation ? of cheating strategies
- Add a citation.cff file HOT 6
- Links to contributing guide broken by docs restructure
- CI failing due to typing issues HOT 3
- Implement asymmetric games HOT 6
- Game classification HOT 4
- Implement abstract games more fully (5.0.0)
- Restructure strategies folder HOT 4
- Documentation for 5.0.0
- Simplify/move the `ResultSet` HOT 1
- Expressing in a formal logical language HOT 2
- You may have missed some details in your code HOT 1
- I couldn't find the strategy submitted by Mauk in the competition for 19th place HOT 2
- If I want to test the first tournament, what should I do based on your codeοΌ HOT 2
- Do you know the source code of the first tournament? HOT 2
- axelrod.plot.Plot may be incompatible with recent Pandas udpates HOT 2
- Change the TFT in the first tournament HOT 3
- High-noise Tournament for comparison HOT 1
- Supporting Python 3.12 HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from axelrod.