search

dmarro89 / dare-db

Dare-DB is a lightweight in-memory database written in Go, featuring Redis-inspired hashtables and HTTP/HTTPS endpoints for seamless data storage and retrieval, with Docker support for easy deployment
MIT License
16 stars 1 forks source link

Documentation - Add a short notice for contributors #25

Closed vdmitriyev closed 2 weeks ago

vdmitriyev commented 2 weeks ago

Write and add a short notice for contributors. It should contain generic rules on how to make a PR, use discussions and issues. Should be added to README.md.

dmarro89 commented 2 weeks ago

Write and add a short notice for contributors.

It should contain generic rules on how to make a PR, use discussions and issues.

Should be added to README.md.

You're right. I've starting today to write a contributions readme.

vdmitriyev commented 2 weeks ago

@dmarro89 I thought that I am going to do it, but if your want to overtake, it would be totally fine for me. Please find below version that I had written so far. I had re-assigned this issue to you :)

How to contribute

All kind of contributions are welcome (e.g., code, ideas, bugs, comments, documentations, etc.)! If your found a bug open an issue and describe it shortly. If you want to add a feature, feel free to open an issue, assign it to yourself and make a pull request based on your issue. Note that discussion threads are used to discuss ideas.

How to add a new feature using pull request:

  1. Fork the repository (e.g., latest changes must be in develop branch) 
    git clone -b develop https://github.com/dmarro89/dare-db
  2. Create a new branch for your feature. Use number of a newly created issue and keywords (e.g., 10-implement-feature-ABC) 
    git checkout -b 10-implement-feature-ABC
  3. Add changes to the branch 
    git add .
  4. Commit your changes 
    git commit -am 'ADD: add new feature ABC'
  5. Push to the branch 
    git push origin 10-implement-feature-abc/your-feature-name
  6. Open a pull request
  7. Provide a short notice in the pull request according to the following structure:
    • Added: ...
    • Changed: ...
    • Fixed: ...

    • Dependencies: ...