Code Monkey home page Code Monkey logo

Comments (2)

evanplaice avatar evanplaice commented on June 30, 2024

If you have an improvement to make I'd expect that you fork and branch the repo. Just submit a pull request once the changes are ready so I can merge them upstream.

I'd be more-than-happy to add you as a contributor (and likely provide commit access) if you're genuinely interested on improving the project.

I don't have an 'official' contributions guide written yet so here's a few ad-hoc guidelines:

  1. Practice good code etiquette

    Fight the temptation to make 'superficial' changes. By which I mean, rearranging functions or changing the coding style in a way that doesn't add value.

    Most/all of the functions are written in an object declarative form, I'm not planning to change the style from the current form without a good justification.

  2. Avoid adding dependencies

    In an effort to keep the library as lightweight as possible I'd like to keep the dependencies to a minimum. Dependencies for developing the library should always be added under devDependencies.

  3. Don't change the API between versions

    A lot of though went into creating a clear/concise API that's straightforward and easy to implement. Keep in mind that other projects may depend on and extend the functionality of this one. API changes will be planned in advance and scheduled to occur during major version increments (ie 1.x.x, 2.x.x) only.

    For example, the grunt-ftpsync project depends on this project to provide ftp synchronization through the grunt task runner. In the future I'd also like to add support for gulp (or any other automation services that prove useful).

    The current versioning structure follows the semver standard. If you're not familiar with it take a moment to read through the documentation to better familiarize yourself.

Otherwise, happy coding.

from node-ftpsync.

Nerom avatar Nerom commented on June 30, 2024

OK , got it !

from node-ftpsync.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.