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

Jump to bottom

Formatting and Coding Guidelines #982

Closed
igormcoelho opened this issue Aug 1, 2019 · 7 comments
Closed

Formatting and Coding Guidelines #982

igormcoelho opened this issue Aug 1, 2019 · 7 comments
Labels
Discussion Initial issue state - proposed but not yet accepted Enhancement Type - Changes that may affect performance, usability or add new features to existing modules. Housekeeping Small enhancements that need to be done in order to keep the project organised

Comments

@igormcoelho
Copy link
Contributor

This issue intends to group PR that only format or do small fixes on Neo.

Please, let's not close this. Could we pin it @lock9?
@igormcoelho igormcoelho mentioned this issue Aug 1, 2019
Merged
@lock9
Copy link
Contributor

lock9 commented Aug 1, 2019

@igormcoelho we can add a section to the #977 for these small issues, and have one issue created per adjustment. I prefer to have a single issue pinned.
I'm using VS Code repository in GitHub as "inspiration" (we are far from the perfect format).

@igormcoelho
Copy link
Contributor Author

igormcoelho commented Aug 1, 2019 •
edited
Loading

Perhaps no need to Pin this. This is just a global catalogue for all PR that are solving this "same issue" (which is, maintaining codebase organized and formatted). We can add a link to this issue from your pinned issue, what do you think? The point is being easy for developers to find this, when they are submitting formatting and small cosmetic fixes.
On the other hand, if this evolves to a really nice code formatting issue/guide (and we remove these comments, perhaps), it would be an easy way to new developers to find code guidelines (this is the intention). Perhaps we could block comments here, as a read-only issue.

@lock9
Copy link
Contributor

lock9 commented Aug 2, 2019

@igormcoelho I'm ok of having lists: we can have as many as you want. I really love lists.

I would like to add a section in that issue regarding other small issues too, but I would like to track them there because I want to be sure we will also test everything that is added.

@lock9 lock9 added the Discussion Initial issue state - proposed but not yet accepted label Aug 2, 2019
@lock9
Copy link
Contributor

lock9 commented Aug 4, 2019

@igormcoelho I created a tag for "check-lists". Maybe we could have more than one issue pinned, after all, why not?
Could you start creating the list using the - [ ] format?

@lock9 lock9 added check-list and removed Discussion Initial issue state - proposed but not yet accepted labels Aug 4, 2019
@lock9 lock9 pinned this issue Aug 5, 2019
@lock9 lock9 unpinned this issue Aug 5, 2019
@lock9
Copy link
Contributor

lock9 commented Aug 5, 2019 •
edited
Loading

@igormcoelho I would like to pin this issue, could you start adding items to the list?

@lock9 lock9 mentioned this issue Aug 5, 2019
Closed
@lock9 lock9 added Housekeeping Small enhancements that need to be done in order to keep the project organised Discussion Initial issue state - proposed but not yet accepted Enhancement Type - Changes that may affect performance, usability or add new features to existing modules. and removed check-list labels Aug 9, 2019
@lock9
Copy link
Contributor

lock9 commented Aug 9, 2019

Hi @igormcoelho, do you think this is a duplicate of #560 ? I was organizing issues and realized that they are almost identical (in the title).
Regarding how we filter those small fixes, I think we could use the house-keeping tag. I also created a cosmetic tag.
Do you think we could close this issue and try to use the tags instead? About code formatting, can we continue in #560 ? (because it is older).
Thanks

@igormcoelho igormcoelho mentioned this issue Aug 24, 2019
Merged
@igormcoelho
Copy link
Contributor Author

@lock9 it's not duplicate, this is just a placeholder for formatting PR and cosmetic changes.

This was referenced Aug 25, 2019
Closed
Merged
shargon added a commit to neo-project/neo-devpack-dotnet that referenced this issue Aug 25, 2019
@shargon
Check dotnet format in travis
2bdc540 
This will prevent to push any format error

Related to neo-project/neo#982
@shargon shargon mentioned this issue Aug 25, 2019
Merged
@igormcoelho igormcoelho mentioned this issue Aug 25, 2019
Merged
igormcoelho pushed a commit to neo-project/neo-devpack-dotnet that referenced this issue Aug 26, 2019
@shargon @igormcoelho
Check dotnet format in travis (#94)
b73bd74 
* Check dotnet format in travis 

This will prevent to push any format error

Related to neo-project/neo#982

* Update .travis.yml

* Update .travis.yml

* dotnet format

* updated travis

* few small changes on final line break

* test -> tests

* more tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Discussion Initial issue state - proposed but not yet accepted Enhancement Type - Changes that may affect performance, usability or add new features to existing modules. Housekeeping Small enhancements that need to be done in order to keep the project organised
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@igormcoelho @lock9