Updating contributing.md file or a adding a QuickStart.md file #13710
josephBabal
started this conversation in
General
Replies: 1 comment
-
Thanks for sharing this with us. It's o helpful for me. destiny card balance |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hello,
I'm currently working on updating the contributing.md file to make it easier for new contributors to start contributing to the project. I believe that having a more detailed guideline can help improve the onboarding experience for contributors.
I will add what I have so far. The changes I have so far are probably not perfect and I would love to have feedback on how to make it better. I would appreciate feedback on the entire thing, however, step 4 (code) and step 5 (commit) are what I need most help with.
Feel free to share your thoughts, questions, or concerns. Please let me know if I can make an issue/pull request for this as well.
Thank you!
Here is what I have so far:
Quick Start
Step 1: Fork
Fork the project github and clone your fork locally
Step 2: Branch
Now create a branch using the git
checkout
command:Step 3: Run the code
Run
bash npm install -g pnpm
to install pnpm on your systemOur code formatting rules are defined in the
"prettier"
section of package.json. You can check your code against these standards by running:To automatically fix any style violations in your code, you can run:
Running tests
You can run the test suite using the following commands:
Step 4: Code (keep?)
This part will explain where most of the code changes would happen.
Step 5: Commit
It is a best practice to keep your changes as logically grouped as possible within individual commits.
Commit message guide
A commit message should describe what changed and why.
Step 6: Push
Once you are sure your commits are ready to go, with passing tests and formatting, begin the process of opening a pull request by pushing your working branch to your fork on GitHub.
Step 7: Submit the pull-request
Go to your repository on GitHub and click the Compare & pull request button.
Submit the pull-request.
Beta Was this translation helpful? Give feedback.
All reactions