PR Template & Updating Contributing guidelines #1121
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pr template
markdown extension
trying with a single file
Different folder
text review
Codecov Report
@@ Coverage Diff @@
## master #1121 +/- ##
=========================================
Coverage ? 64.34%
=========================================
Files ? 200
Lines ? 13690
Branches ? 0
=========================================
Hits ? 8809
Misses ? 4881
Partials ? 0Continue to review full report at Codecov.
|
shargon
reviewed
Sep 27, 2019
lock9
commented
Sep 27, 2019
shargon
reviewed
Sep 27, 2019
shargon
reviewed
Sep 27, 2019
Co-Authored-By: Shargon <shargon@gmail.com>
shargon
previously approved these changes
Sep 30, 2019
|
@neo-project/core one more approval please |
This was referenced Oct 1, 2019
Closed
shargon
previously approved these changes
Oct 15, 2019
|
@igormcoelho @vncoelho @erikzhang please help me approve this. If you want changes, please request changes. |
|
Hi @vncoelho, I removed the changelog file. |
erikzhang
reviewed
Dec 6, 2019
.github/pull_request_template.md
Outdated
| **Checklist** | ||
| - [ ] Did you add tests covering your changes? | ||
| - [ ] Did you run `dotnet format`? | ||
| - [ ] Did you update `CHANGELOG.md` with your changes? |
|
@erikzhang Done |
vncoelho
requested changes
Dec 7, 2019
vncoelho
reviewed
Dec 8, 2019
There was a problem hiding this comment.
@lock9,I tried to commit directly or modify but I was not allowed:
I wrote the following modifications:
# Contributing to NEO
Neo is an open-source project and it depends on its contributors and constant community feedback to implement the features required for a smart economy. You are more than welcome to join us in the development of Neo.
Read this document to understand how issues are organized and how you can start contributing.
*This document covers this repository only and does not include community repositories or repositories managed by NGD Shanghai and NGD Seattle.*
### Questions and Support
The issue list is open for any kind of discussions, questions and interaction with the collaborators of the project. In addition, it is also a good place for bug reports, possible features and optimizations. Do not hesitate to initiate any discussion. However, please, kindly take a look at possible similar keywords in order to try to find a possible connection with your idea.
### dApp Development
This document does not relate to dApp development. If you are looking to build a dApp using Neo, please [start here](https://neo.org/dev).
### Contributing to open source projects
If you are new to open-source development, please [read here](https://opensource.guide/how-to-contribute/#opening-a-pull-request) how to submit your code.
## Developer Guidance
We try to have as few rules as possible, just enough to keep the project organized:
1. **Discuss before coding**. Proposals must be discussed before being implemented.
Avoid implementing issues with the discussion tag.
2. **Tests during code review**. We expect reviewers to test the issue before approving or requesting changes.
3. **Wait for at least 2 reviews before merging**. Changes can be merged after 2 approvals, for Neo 3.x branch, and 3 approvals for Neo 2.x branch.
3. **Give time to other developers review an issue**. Even if the code has been approved, you should leave at least 24 hours for others to review it before merging the code.
4. **Create unit tests**. It is important that the developer includes basic unit tests so reviewers can test it.
5. **Task assignment**. If a developer wants to work in a specific issue, he may ask the team to assign it to himself. The proposer of an issue has priority in task assignment.
### Issues for beginners
If you are looking to start contributing to NEO, we suggest you start working on issues with  or  tags since they usually do not depend on extensive NEO platform knowledge.
### Tags for Issues States
 Whenever someone posts a new feature request, the tag discussion is added. This means that there is no consensus if the feature should be implemented or not. Avoid creating PR to solve issues in this state since it may be completely discarded.
 When a feature request is accepted by the team, but there is no consensus about the implementation, the issue is tagged with design. We recommend the team to agree in the solution design before anyone attempts to implement it, such as using text, UML, pseudo-code and proofs-of-concepts.
Note that PRs for issues in this state may also be discarded if the team disagree with the proposed solution.
 Once the team has agreed on feature and the proposed solution, the issue is tagged with ready-to-implement. When implementing it, please follow the solution accepted by the team.
### Tags for Issue Types
 Issues with the cosmetic tag are usually changes in code or documentation that improve user experience without affecting current functionality. These issues are recommended for beginners.
 Enhancements are platform changes that may affect performance, usability or add new features to existing modules. It is recommended that developers have previous knowledge in the platform to work in these improvements, specially in more complicated modules like the compiler, ledger and consensus.
 New features may include large changes in the code base. Some are complex, but some are not. So, a few issues with new-feature may be recommended for starters.
 Issues related to the migration from Neo 2 to Neo 3 are tagged with migration. These issues are usually the most complicated ones since they require a deep knowledge in both versions.
### Tags for Project Modules
These tags do not necessarily represent each module at code level. Modules consensus and compiler are not recommended for beginners.
 Issues that are related or influence the behavior of our C# compiler. Note that the compiler itself is hosted in the [neo-devpack-dotnet](https://github.com/neo-project/neo-devpack-dotnet) repository.
 Consensus is used for reaching an agreement on which information will be published block by block. Changes to consensus are usually harder to make and test.
 The ledger is our 'database', any changes in the way we store information or the data-structures have this tag.
 'Small' enhancements that need to be done in order to keep the project organised and ensure overall quality. These changes may be applied in any place in code, as long as they are small or do not alter current behavior/logic.
 Identify issues that affect the network-policy like fees, access list or other related issues. Voting may also be related to the network policy module.
 This module includes peer-to-peer message exchange and network optimisations, at TCP or UDP level (not HTTP).
 All HTTP communication is handled by the RPC module. This module usually provides support methods since the main communication protocol takes place at the p2p module.
 New features that affect the Neo Virtual Machine or the Interop layer.
 Neo provides an SDK to help developers to interact with the blockchain. Changes in this module must not impact other parts of the software.
 Wallets are used to track funds and interact with the blockchain. Note that this module depends on a full node implementation (data stored on local disk).
|
@vncoelho is it good? I can't see the order of the messages. When it is done, please remove the request for changes. |
|
Can you apply my last message on the file? Just copy everything from the message and paste on the file. |
|
Or can you allow edit permission? |
shargon
approved these changes
Dec 11, 2019
|
@vncoelho you have to send a PR to my repository |
|
They were already applied. |
vncoelho
approved these changes
Dec 16, 2019
|
|
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close #1118
I tried to have different templates for Neo 3 and Neo 2 but it didn't work.
I also moved the contributing document to the .github folder.