-
Notifications
You must be signed in to change notification settings - Fork 55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add CONTRIBUTING.md #32
Conversation
f9abbe4
to
959a391
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to have a more friendly document explaining what the steps are for contributing to use that in the future as the main document in GrirmoireLab.
I think we should explain that contributions are accepted only through PRs and what this PRs should contain. Maybe we can use excerpts of this document (https://gist.github.com/mikepea/863f63d6e37281e329f8) and parts of the GrimoireLabs contribution.
We also can re-use some parts of the GitLab's documentation about their changelog tool
959a391
to
cb63f3b
Compare
Hi @sduenas, sorry for taking too long for completing this task. I have worked on your comments and updated the PR. Please have a look when you are free and let me what do you think about it. https://github.com/vchrombie/grimoirelab-toolkit/blob/contributing-info/CONTRIBUTING.md |
2056cdb
to
ad0a388
Compare
Signed-off-by: Venu Vardhan Reddy Tekula <venu@bitergia.com>
ad0a388
to
cb5fccc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this PR needs a major rework. In my opinion is very dense and it takes so much time to find the information someone might need. In somehow, it should be like the style used in news reports: start with a small guide for contributing and then go into the details.
Here are some examples:
https://github.com/rails/rails/blob/main/CONTRIBUTING.md
https://github.com/atom/atom/blob/master/CONTRIBUTING.md
https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md
No description provided.