------------------------------
On Tue, Jun 24, 2014 5:41 PM BST ahi wrote:
>The part with the indentation was fixed but uncommitted, I have pushed
>the changes.
>As for the documentation it is lacking at the moment, I am currently
>facing problems with the parser/lexer and I am attempting to debug it.
I am still waiting for the documentation update. This is the 3rd time I am
requesting it.
You MUST make an effort in the next 24 hours.
I am also extremely concerned about your ideas on schedules and priorities.
You MUST write to the mailing list if you are stuck on any issue for more than
2 days. There are people who are knowledgeable and willing to help, but you
MUST write to let us know. What is/are the problems you are/were facing!!??
It is supposed to be a 60-working days project, so working alone and stuck for
more than 2 days is not good for yourself, or the community. At some point
the project is supposed to engage contributors, so (1) you MUST
make an effort to update the documentation, both at the top level,
and at the individual files, so that others can contribute without being
telepathically
linked to your brain and read your mind, (2) posting your problems - if you
are stuck for more than a day or two - is also a way of engaging others'
interests.
you MUST write if you are stuck on any issue for more than a day or two.
On the smaller details,
- you probably should read the python style guide (url posted in an earlier
e-mail),
as well as use one of the pep8 utils (url posted by somebody else in a
different thread)
for tightening some of your coding style, and not make the same mistakes over
and over.
- when you find yourself cutting-and-pasting the same code over and over,
then doing a few search-and-replace, you really should ask yourself, is
there a better way? or ask others. You could really learn to use eval(), as
well as associative
arrays (i.e. look-up tables - "table = { 'name1' : value1, 'name2' : value2}"),
to do most of the things you are doing cut-and-paste and search-replace
for.
- documentations and comments: first of all, it is virtually non-existent. You
MUST
make an effort, ASAP, to do something about it. As for comment and docstrings,
I think you should try to write comments that say something not-obvious,
or overview/summary of lengthy code. Repeating/describing code in comments
is not a very good way of using bits and byes.
- try not to commit code that simply does not run. You haven't reached the stage
where you care about regressions (i.e. code that used to work does not any
more),
but when you reach a certain complexity, you will need to have
"known good points" to start from, to track down newly introduced problems.
Do not get into the habit of blindly writing and commiting code that has never
been run
ever.
On the last issue, you probably should learn a bit more about git rebase
("man git-rebase") and in particular, the --interactive option, to rewrite your
history,
and re-arranging your commits, before you push to the public repository;
I also occasionally do a
git show > /tmp/file
git revert
edit /tmp/file, remove stuff that does not work, run patch to re-add,
do "git rebase -i ...", collapse some of the changes, etc
to separate changes that are some-good-some-bad, and modify/clean-up the commit
messages, etc, before pushing.
The granularity of your commits are very poor
at the moment - large and bulky changes that goes from does-not-run to
does-not-run,
with very short descriptions of what's supposed to have changed and why.
I think you would also benefit from
git config --global color.ui true
If you have a favourite editor, you should also do:
git confiig --global core.editor emacs
(I use emacs here, but you might prefer something else). I don't know what the
default
is - probably vi - but that's my setting since I started using git. This means
your favourite
editor is used for commit messages, interactive rebase, etc, and any sort
of composing/editing launched by git.
bye for now. Please, you MUST update the documentation in the next 24 hours.
_______________________________________________
Spdx-tech mailing list
[email protected]
https://lists.spdx.org/mailman/listinfo/spdx-tech
