Giter VIP home page Giter VIP logo

Comments (4)

fMeow avatar fMeow commented on May 31, 2024

That's great. And what should be included in a CONTRIBUTING.md file?

from arangors.

arn-the-long-beard avatar arn-the-long-beard commented on May 31, 2024

Hoo yes, I should have give examples :)

1 - For example we could describe the way we write commit messages, depending of its content.

  • test: updated unit test -> When we update code on unit test

  • doc: added doc for constructor -> When we write documentation

  • fix: fixed deserialization bug due to error handling -> When we fix a bug

  • feat: added collection::create_document -> When we add a new feature

and more

2 - We could describe how we can write PR description maybe

3 - We could describe how we write unit test

I am thinking about this kind of stuff, so we all know how we should write our commits and which best practice we should have. It can be obvious and natural for some people but, beginners like me need it :P

And I think Rust is so awesome ( and Arango also :D ), we are going to have more and more people joining and willing to help.

from arangors.

arn-the-long-beard avatar arn-the-long-beard commented on May 31, 2024

Ho yes I found this https://gist.github.com/abravalheri/34aeb7b18d61392251a2

from arangors.

fMeow avatar fMeow commented on May 31, 2024

Finally, now arangors has a contribution guide!

Thank you so much! :)

from arangors.

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.