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.

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

As a user, I would like to add code to the code repository so that it would be helpful to other developers #10

Open
sivaraam opened this issue Feb 22, 2017 · 3 comments

Comments

@sivaraam
Copy link
Owner

sivaraam commented Feb 22, 2017

  1. The plug-in must ask for a title, a brief description and the how to use the code (documentation) upon trying to add code to the code repository.

  2. The header files and other functions (dependencies) required for correct functioning of the code should be provided. If it requires functions other than the ones provided by the standard library they must be present in the code repository else they must be added to the code repository.

  3. The code must be reviewed by other developers to ensure the quality of the code.

@sivaraam
Copy link
Owner Author

So, we basically should ask for the following, before allowing the user to add code to repository :

  1. Title
  2. Brief description
  3. How to use the code (documentation)
  4. Required headers for correct functioning

@sivaraam
Copy link
Owner Author

One more thing that needs to be discussed is the second point of the description. The other functions required for correct functioning needs to be checked. How it is to be done is not so clear as there are a few alternatives do that. Decision to be made after discussion.

@sivaraam
Copy link
Owner Author

sivaraam commented Feb 22, 2017

One more suggestion that could be considered is that, the code that the user is trying to add could be checked to ensure that it is a syntactically correct code - so that it would be easy for the reviewer as he would need to review only it's quality. The reviewer wouldn't be frustrated as he need not check the code for missing parantheses (or) a missing semicolon, instead of checking for the quality of the code.

@sivaraam sivaraam reopened this Mar 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants