Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I am kind of obsessed with how I document and organize my projects. I am curious about best practices for readme files, and looking to learn more about what should be in it. I am mostly using rails. But I believe that readme should make no assumptions about the reader and explain everything with from scratch. So what would be your ideal descriptive timeless readme file for web application projects? Also It would ve very helpful if you attach the readme files you like.
content? short info the about app? language, framework? screenshot? format? markdown vs plain? ideal deployment? etc..
If you don't make assumptions about the reader then plain text is the best choice. Any markup language needs to be parsed and converted which may not be possible when viewing the readme locally. Sites such as Github support various markup formats which is good but you're limited to what they support.
It terms of content: it should explain everything that the user would possibly want to do, such as compile, build, run, modify, et cetera.
Related
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I am beginner in ROR. I am working on one project. I want to know the better option between for deployment of the app.
My answer will be more conceptual, rather then technical.
This is the first time I hear about Google App Engine in case of Rails. This is mostly a crucial reason, why I would say, that you definitely better go with Heroku.
While you are a beginner, it's better to use the most widely spread solutions and tools. Heroku has a huge history and you can find any answers in the internet very easily. It's well known among rails community and everyone can make a small consultation according to it.
Even if Google App Engine would be better or cheaper (haven't checked it), you shouldn't start such experiments until you have good deploy/rails knowledge.
Closed. This question needs details or clarity. It is not currently accepting answers.
Want to improve this question? Add details and clarify the problem by editing this post.
Closed 7 years ago.
Improve this question
I wish to use threads and concurrency features of Go language in my Ruby on Rails project. I have several alternatives, one of them is jRuby. But, I don't like Java (personal preference). I have heard that Go Lang is a perfect replacement for Java. Its even more faster & secure than Java. I saw people comparing its speed to C++ as some of its part is in Assembly itself. People can even write a complete web server like Apache from scratch in Go.
What I am really planning for is: All the low level stuff in Go and rest of it Ruby on Rails. I still want to have the ease of development that RoR has to offer.
Starting in Go 1.5, there is a build mode called c-shared, which allows you to build C shared libraries in Go. These can then be loaded into Ruby using FFI and used in your Rails app. See this brief introduction to the concept.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this question
Is there any standard way to build developer, just making the developers understand the code easily after delivering, if you have sample it's better
If you want to know how to make your code better, you need to read about SOLID and other object-oriented design patterns.
There are no official Apple developer programming style guides.
I.e.: no official "Programming Standards" exist.
Standard only exist in terms of UI, external appearance of your application.
Normal software development criteria apply:
commenting
using software patterns appropriately, as pointed out in another answer, SOLID makes a lot of sense. Just in order to understand Apple Frameworks you need to know software patterns: delegation, visitor, proxy, etc.
document requisites and change requests, api and architecture if the app is complex
don't rely too much on bug tracking, these tend to be abused (change requests marked as bugs) and might add too much complexity of their own (JIIRA).
your organization may adopt an existing programming "quality standard" and adapt it to iOS development. ITIL is and ISO are usually overkill.
Sometimes it makes no sense to over-optimize and over-engineer everything, including your code and programming standards.
Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 7 years ago.
Improve this question
I want to build a web application. I'm wondering how I can find the best practices for front end development.
Although this is a general question.And Full answer to this question should be a big article that i will not be able to add in answer.But i can include some information that is useful.There will be lot of Information available on Web to learn and do best practice for Front end developer.Most of best practice you will learn by following blogs and by your own practice.
Few Tips that i would add are below.
Correct Syntax Makes Beautiful Code
Testing Your Site in Different Resolutions of screen size Desktop and Mobile
Test site using different Environments and browsers
Think about Future usability of the Site
Try to make it more responsive,fast and User friendly
Here are few Helpful Articles
http://www.sitepoint.com/20-docs-guides-front-end-developers/
http://taitems.github.io/Front-End-Development-Guidelines/
http://www.catswhocode.com/blog/top-10-best-practices-for-front-end-web-developers
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this question
I want to create several niche Q&A sites similar to StackExchange.
Which approach is best?...
A) Rails mountable engine. New sites would be full rails apps that would use this engine. The mountable engine would provide the complete Q&A site (code, visual styling, etc).
B) Single multi-tenant app. A single rails app where each new site would be added as a tenant. In this approach, something would be needed to customize the styles for each new site (logo, header, etc).
Which approach would you recommend?
I would suggest you go with Single app multi-tenant.
I had implemented this in an old project on http://mentii.com. This is a mentoring platform, but I guess similar challenges as Q&A apply.
Here, each community would get a version of the app whitelabled to their needs. I found the approach to be scalable as well as well as maintainable.