Skip to content
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

Getting_In_Touch.rst: Add COC reference link. #561

Merged
merged 1 commit into from
Jun 21, 2018

Conversation

chhabrabhishek
Copy link
Contributor

@chhabrabhishek chhabrabhishek commented Jun 20, 2018

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

  • I read the commit guidelines and I've followed
    them.
  • I ran coala over my code locally. (All commits have to pass
    individually.
    It is not sufficient to have "fixup commits" on your PR,
    our bot will still report the issues for the previous commit.) You will
    likely receive a lot of bot comments and build failures if coala does not
    pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

Copy link
Member

@nvzard nvzard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chhabrabhishek please read the commit guidelines and edit your commit message accordingly.

Also, add issue link in you commit message.

Copy link

@saksham189 saksham189 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commit message is still incorrect. Use git commit --amend to change it and read the commit guidelines. Look at some of the examples here and ask if you have any doubts
http:https://api.coala.io/en/latest/Developers/Writing_Good_Commits.html

@chhabrabhishek
Copy link
Contributor Author

@anctartica is my commit incorrect syntactically or logically? I mean do I have a need to correct the content written in it or am I commiting it incorrectly?

Copy link
Member

@pareksha pareksha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue corresponding to your PR isn't a bug. Use Closes instead of Fixes in your commit message.
Also in the shortlog, use Add instead of Added.

@ankitxjoshi
Copy link
Contributor

Update Added to Add. You can refer this to understand why.

@chhabrabhishek chhabrabhishek changed the title Getting_In_Touch.rst: Added reference link for COC Getting_In_Touch.rst: Add COC reference link. Jun 20, 2018
@@ -24,3 +24,6 @@ Modularity, clean good code as well as a high usability for both users
and developers of analyse routines (called bears) stand in the
foreground of the development. We will not speed up our development if
it needs sacrificing any aspect of quality.


Please follow our Code Of Conduct, you can find it `here <http:https://docs.coala.io/en/latest/Help/FAQ.html#what-is-coala-community-code-of-conduct>`__.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page is about contacting people.

This should be after "- Give us feedback", as a new item,

Copy link
Member

@ksdme ksdme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chhabrabhishek While we are at it please update the commit message body, it would look better if it says something like Introduce feedback section and adds CoC reference.

Give Us Feedback
================

- Report any `Code Of Conduct <http:https://docs.coala.io/en/latest/Help/FAQ.html#what-is-coala-community-code-of-conduct>`__

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: docs.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpy96jet4g/Help/Getting_In_Touch.rst
+++ b/tmp/tmpy96jet4g/Help/Getting_In_Touch.rst
@@ -29,5 +29,5 @@
 Give Us Feedback
 ================
 
--  Report any `Code Of Conduct <http:https://docs.coala.io/en/latest/Help/FAQ.html#what-is-coala-community-code-of-conduct>`__ 
+-  Report any `Code Of Conduct <http:https://docs.coala.io/en/latest/Help/FAQ.html#what-is-coala-community-code-of-conduct>`__
    violations to ``community AT coala DOT io``.

Help/.coafile Outdated
[cli]
bears = SpaceConsistencyBear
files = Getting_In_Touch.rst
use_spaces = True

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't need this. Why have you added a .coafile here? There is already one in the project that has the SpaceConsistencyBear

Copy link
Contributor Author

@chhabrabhishek chhabrabhishek Jun 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anctartica I did'nt added this file, I just ran the coala's space consistency bear on Getting_In_Touch.rst file and this .coafile generated automatically.Do I remove it?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove it from the commit

@@ -24,3 +24,10 @@ Modularity, clean good code as well as a high usability for both users
and developers of analyse routines (called bears) stand in the
foreground of the development. We will not speed up our development if
it needs sacrificing any aspect of quality.


Give Us Feedback

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't need a new section

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but @anctartica can you see what @jayvdb had reviewed
he said me to add a new section

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anctartica is it correct or does it need any changes?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

he never mentioned a new section.

This should be after "- Give us feedback", as a new item

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a new point below the "- Give us feedback" point

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and do i have to write report at community AT coala DOT io
or do I simply write report at gitter and mail

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you believe someone is violating the code of conduct, we ask that you report it by emailing community AT coala DOT io.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is mentioned in COC

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it correct now? Or does it need any changes?

Copy link
Contributor Author

@chhabrabhishek chhabrabhishek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

`

Add CoC violation reporting email.

Closes coala#553
@ksdme
Copy link
Member

ksdme commented Jun 21, 2018

Any opinion on if we should should have a wrapped link - If you believe someone is violating the code of conduct <http:https://docs.coala.io/en/latest/Help/FAQ.html#what-is-coala-community-code-of-conduct>__ to maintain line length?

@jayvdb
Copy link
Member

jayvdb commented Jun 21, 2018

ack c596e8b

@jayvdb
Copy link
Member

jayvdb commented Jun 21, 2018

@gitmate-bot ff

@gitmate-bot
Copy link

Hey! I'm GitMate.io! This pull request is being fastforwarded automatically. Please DO NOT push while fastforward is in progress or your changes would be lost permanently ⚠️

@gitmate-bot gitmate-bot merged commit c596e8b into coala:master Jun 21, 2018
@jayvdb
Copy link
Member

jayvdb commented Jun 21, 2018

While line length is important, this was a good attempt at balancing line length and readibility factors, The result is mergable for user-docs. I probably would have been stricter in dev-docs ;-)

@gitmate-bot
Copy link

Automated fastforward with GitMate.io was successful! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

8 participants