Added the Contributing.md and Code of Conduct File into the Repo #244
Conversation
thunderbiscuit
left a comment
thunderbiscuit
left a comment
There was a problem hiding this comment.
Hi @ConnectBhawna! Thanks for taking the time to open a PR. Adding a CONTRIBUTING file is a good idea.
I'm reading this over and think the code of conduct might be a little bit too heavy-handed for what I want. I'm thinking of maybe writing one of my own that would be much simpler. Do you mind removing that file?
As for the contributing file, let's start with just the basics. I like that it exists, and I can imaging things we might want to add to it. But basic git workflows I don't think belong there for now (also they're not quite the workflows I would recommend in any case).
CONTRIBUTING.md
Outdated
| ## Code of Conduct | ||
|
|
||
| This project and everyone participating in it is governed by the [Padawan Wallet Code of Conduct](), please follow it in all your interaction with the project. By participating, you are expected to uphold this code. Please report unacceptable behavior to @thunderbiscuit | ||
|
|
||
|
|
||
| ## Pull Request Process | ||
|
|
||
| 1. Ensure any install or build dependencies are removed before the end of the layer when doing a | ||
| build. Add only relevant files to commit and ignore the rest to keep the repo clean. | ||
| 2. Update the README.md with details of changes to the interface, this includes new environment | ||
| variables, exposed ports, useful file locations and container parameters. | ||
| 3. You should request review from the maintainers once you submit the Pull Request. | ||
|
|
||
| ## Instructions | ||
|
|
||
| - Git Workflow | ||
|
|
||
| ```bash | ||
| ## Step 1: Fork Repository | ||
|
|
||
| ## Step 2: Git Set Up & Download | ||
| # Clone the repo | ||
| $ git clone https://github.com/<User-Name>/<Repo-Name> | ||
| # Add upstream remote | ||
| $ git remote add upstream https://github.com/thunderbiscuit/padawan-wallet | ||
| # Fetch and merge with upstream/master | ||
| $ git fetch upstream | ||
| $ git merge upstream/master | ||
|
|
||
| ## Step 2: Create and Publish Working Branch | ||
| $ git checkout -b <type>/<issue|issue-number>/{<additional-fixes>} | ||
| $ git push origin <type>/<issue|issue-number>/{<additional-fixes>} | ||
|
|
||
| ## Types: | ||
| # wip - Work in Progress; long term work; mainstream changes; | ||
| # feat - New Feature; future planned; non-mainstream changes; | ||
| # bug - Bug Fixes | ||
| # exp - Experimental; random experimental features; | ||
| ``` | ||
|
|
||
| - On Task Completion: | ||
|
|
||
| ```bash | ||
| ## Committing and pushing your work | ||
| # Ensure branch | ||
| $ git branch | ||
| # Fetch and merge with upstream/master | ||
| $ git fetch upstream | ||
| $ git merge upstream/master | ||
| # Add untracked files | ||
| $ git add . | ||
| # Commit all changes with appropriate commit message and description | ||
| $ git commit -m "your-commit-message" -m "your-commit-description" | ||
| # Fetch and merge with upstream/master again | ||
| $ git fetch upstream | ||
| $ git merge upstream/master | ||
| # Push changes to your forked repository | ||
| $ git push origin <type>/<issue|issue-number>/{<additional-fixes>} | ||
|
|
||
| ## Creating the PR using GitHub Website | ||
| # Create Pull Request from <type>/<issue|issue-number>/{<additional-fixes>} branch in your forked repository to the master branch in the upstream repository | ||
| # After creating PR, add a Reviewer (Any Admin) and yourself as the assignee | ||
| # Link Pull Request to appropriate Issue, or Project+Milestone (if no issue created) | ||
| # IMPORTANT: Do Not Merge the PR unless specifically asked to by an admin. | ||
| ``` | ||
|
|
||
| - After PR Merge | ||
|
|
||
| ```bash | ||
| # Delete branch from forked repo | ||
| $ git branch -d <type>/<issue|issue-number>/{<additional-fixes>} | ||
| $ git push --delete origin <type>/<issue|issue-number>/{<additional-fixes>} | ||
| # Fetch and merge with upstream/master | ||
| $ git checkout master | ||
| $ git pull upstream | ||
| $ git push origin | ||
| ``` | ||
|
|
||
| - Always follow [commit message standards](https://chris.beams.io/posts/git-commit/) | ||
| - About the [fork-and-branch workflow](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/) |
There was a problem hiding this comment.
Let's remove this part and only keep the top welcome message.
|
Let me know if you're familiar with amending and force-pushing commits. In this case I'm looking for 1 commit, and I use the conventional commits convention including capitalizing the first word of the commit message and the active verb approach. For example your commit here would be: Docs: Add CONTRIBUTING.md file |
|
Okk @thunderbiscuit sir let me do this :) |
|
Perfect thanks! Just two little things: I get notifications when people open issues or PRs on the repo, and when they comment on any of those. No need to tag me in all your messages 🤣. Also, you don't need to call me Sir. |
|
Added the changes as you mentioned sir :) |
|
I think you still have 3 commits, and incorrect commit messages. Let me know if you'd like help on how to fix this (see my message above). You'll need to do an interactive rebase and force-push your new commit. In this case I'm looking for 1 commit, and your commit message will be: Docs: Add CONTRIBUTING.md file |
ConnectBhawna
force-pushed
the
added-contribution
branch
from
7b02d70 to
4ee9dfd
Compare
2 participants
I have added a Code of conduct along with Contributing guidelines to the project. In my Contributing guideline, I have not provided a link for the IHR Code of conduct, in case this gets merged I would add the link else the link would redirect to my repo. Let me know what you think about the rules and approach I have provided. @thunderbiscuit sir incase you need some changes let me know I would make and send the PR again.
Solved issue #245