search

ZencypherSolutions / semaphore-stellar-contracts

MIT License
2 stars 13 forks source link

docs: create CONTRIBUTING.md file #5

Closed evgongora closed 4 weeks ago

evgongora commented 4 weeks ago

Create a CONTRIBUTING.md explaining the process to create an issue, and fork the repo. Also, you must include best practices for naming, since this is a docs repository. The name for issues can be docs or research.

Any additional suggestions are welcome!

binayak9932 commented 4 weeks ago

@evgongora I am a new contributer and have contributed to may repos i think i can make a CONTRIBUTING.md with very easy and clear instructions. Time frame :under 1 Day

KevinMB0220 commented 4 weeks ago

Hello, I'm part of the Dojo Coding community and have experience in documentation and best practices for open-source projects. I would like to contribute to the CONTRIBUTING.md file to ensure that the guidelines for creating issues and forking the repository are clear and accessible for new contributors. Additionally, I can include suggestions on naming conventions to align with the structure of the repository. I'm ready to collaborate and contribute in any additional way needed! @evgongora

KevinLatino commented 4 weeks ago

I am applying to this issue via OnlyDust platform.

I am a Dojo Coding member

I would love to take on this task to create a CONTRIBUTING.md file for the repository. Here's what I plan to include:

Forking the Repository:

Detailed steps on how to fork the repo using GitHub. Instructions on cloning the forked repo to their local machine.

Creating an Issue: A step-by-step guide on how to create an issue, including the necessary details to include. Examples of well-structured issues. Best Practices for Naming:

Suggestions for naming issues, focusing on clarity and specificity. A recommended naming convention, such as using prefixes like [Docs] or [Research] to categorize the issue. Additional Suggestions:

Encouraging contributors to follow a template for issues when applicable. Suggestions for reviewing and commenting on other issues or contributions.

I welcome any additional suggestions or requirements you might have!

Benjtalkshow commented 4 weeks ago

Hello @evgongora Can this task be assigned to me? I will make PR in 5hrs .

PoulavBhowmick03 commented 4 weeks ago

I’d like to help with this.

I will do as asked, create a CONTRIBUTING.md, I will create and write proper instructions on how to create an issue, fork the repo and for the best practices I will also add a template for users to use to create a PR, and other resources for them to refer to for various sections

ETA- 12 hours

JosueBrenes commented 4 weeks ago

Hi, I'm Josué Brenes and I'll be working on issue. I'm Dojo Coding member.

I estimate this will take 1 day to complete.

How I would resolve this

The CONTRIBUTING.md file should provide clear guidelines for contributing to the repository. For example you can carry the following

Creating an Issue

  1. Go to the Issues tab.
  2. Click on New Issue.
  3. Choose a title format for the issue:
    • For documentation-related issues, use the prefix docs.
    • For research-related issues, use the prefix research.
  4. Provide a detailed description of the issue, including any relevant context, screenshots, or error messages.
  5. Submit the issue.

Forking the Repository

  1. Click on the Fork button in the top right corner of the repository page.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/your-username/repo-name.git
  3. Create a new branch for your contribution: 
    git checkout -b feature/your-feature-name
  4. Make your changes, commit them, and push the branch to your fork: 
    git add .
git commit -m "Description of your changes"
git push origin feature/your-feature-name

Submitting a Pull Request

  1. Go to the original repository.
  2. Click on Pull Requests and select New Pull Request.
  3. Choose the branch from your fork and create the pull request.
  4. Provide a clear and descriptive title and description for the pull request.

Naming Best Practices

josephpdf commented 4 weeks ago

Hi!, my name is Joseph Poveda. I am a student of the Systems Programming degree, I am a recent member of the Dojo Coding community, where I am getting started in the world of Web3. To approach this issue, I would first create a CONTRIBUTING.md file explaining the steps for creating an issue and forking the repository. I’d include naming best practices, such as using "docs" or "research" as prefixes to categorize content types. Additionally, I’d offer general advice on organizing documentation and summarize collaboration best practices, especially for documentation repositories, while providing extra tips on structuring and clarity for documentation.

NueloSE commented 4 weeks ago

May I try my hand at this?

petersdt commented 4 weeks ago

I'd love to give this a go.

martinvibes commented 4 weeks ago

Can I work on this, please?

kindly assign :)

Contributing to the Project

Getting Started

Pull Requests

Push your branch and open a PR with a clear title and description. Reference related issues for context.

derianrddev commented 4 weeks ago

Hello, I’m Derian, a software engineer focused on full-stack web development and currently part of Dojo Coding. I’d like to work on this issue.

How I would resolve the issue:

Create the CONTRIBUTING.md file with the sections described in the issue, along with any additional suggestions. Save and upload the file to the repository. If I have questions, I’ll ask them as soon as possible in the Telegram group. I will open a PR and wait for your feedback. Make any necessary changes according to the PR review.

deeseeker commented 4 weeks ago

I'd like to handle this task.

jsandinoDev commented 4 weeks ago

Hi @bitfalt I'm a full-stack developer with web3 experience member of Dojo Coding, specializing in smart contracts and decentralized applications. I've worked on projects using React, Solidity, Cairo, and blockchain tools. My skills in both front-end and back-end development allow me to build scalable and secure solutions for web3 ecosystems. I have worked on modifying the .md in projects like Shinigami & GoStarkme I would love to work on this issue

LazarusAA commented 4 weeks ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi, I'm Alvaro Lazarus a Blockchain developer and new member of Dojo Coding, I have previous experience writing documentation which makes me confident that I can complete this issue.

How I plan on tackling this issue

I’ll provide clear guidelines for contributing to the repository, including steps for creating issues, forking, and naming best practices to help new contributors follow a consistent process.

Best regards, Lazarus

ETA: 24 hrs