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.

Sign up for GitHub

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

Jump to bottom

Improve "Testing Documentation" in contributing guide #5259

Closed
2 tasks
wouterj opened this issue May 15, 2015 · 6 comments
Closed
2 tasks

Improve "Testing Documentation" in contributing guide #5259

wouterj opened this issue May 15, 2015 · 6 comments
Labels
actionable Clear and specific issues ready for anyone to take them. good first issue Ideal for your first contribution! (some Symfony experience may be required)

Comments

@wouterj
Copy link
Member

wouterj commented May 15, 2015

We should improve http://symfony.com/doc/current/contributing/documentation/format.html#testing-documentation to make it a bit less confusing.

From #3917:

  • We should explain how the build will look like.
  • Tell about the additional _ext directory and how not to add it to the PR.
@wouterj wouterj added good first issue Ideal for your first contribution! (some Symfony experience may be required) actionable Clear and specific issues ready for anyone to take them. labels May 15, 2015
@wouterj wouterj mentioned this issue May 15, 2015
Closed
4 tasks
@snoek09
Copy link

snoek09 commented May 28, 2015

The _exts directory is already in the gitignore file.

@stof
Copy link
Member

stof commented May 28, 2015

@snoek09 the _exts directory is a submodule

@snoek09
Copy link

snoek09 commented May 28, 2015

Also mentioned here: #3917 (comment)
Seems to me it's not needed any more to mention this.

@snoek09 snoek09 mentioned this issue May 28, 2015
Closed
@wouterj
Copy link
Member Author

wouterj commented May 31, 2015

I think we should tell something about the submodule stuff, as it can introduce weird results for git status when you're on an out of date branch. We should explain how to avoid/remove this troube imo

wouterj added a commit that referenced this issue May 31, 2015
@wouterj
bug #5324 5259 improve 'Testing Documentation' in contributing guide …
65817d3 
…(snoek09)

This PR was squashed before being merged into the 2.3 branch (closes #5324).

Discussion
----------

5259 improve 'Testing Documentation' in contributing guide

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets | #5259

Commits
-------

c6ec1c8 5259 improve 'Testing Documentation' in contributing guide
@xabbuh
Copy link
Member

xabbuh commented Jan 15, 2016

I am not sure if we really need to document this anymore now that you can see how your PR will look like thanks to our platform.sh previews.

@javiereguiluz
Copy link
Member

I agree with @xabbuh. The current situation is much better than when this issue was created. Now we validate the syntax with Travis and we provide a real doc rendering thanks to Platform.sh.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
actionable Clear and specific issues ready for anyone to take them. good first issue Ideal for your first contribution! (some Symfony experience may be required)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@javiereguiluz @snoek09 @stof @wouterj @xabbuh