This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH] Replace contribution list in CONTRIBUTE file with wiki link


On 01/25/2019 02:30 PM, Alan Hayward wrote:

> With those changes, we now have: 
> 
> 			Contributing to GDB
> 
> GDB is a collaborative project that relies on contributions.  You can
> help in this!  

Doesn't "help in" sound odd?  I'd expect "help with" to be more
correct here?

> You may wish to fix bugs, improve testing, port GDB to
> a new platform, update documentation, add new features or optimizations,
> contribute to the mailing lists or official GDB website, etc.  We welcome
> all of the above and feel free to ask on the GDB mailing lists if you are
> looking for feedback or for people to review a work in progress.  For
> more information see:
> 
> https://sourceware.org/gdb/contribute/

I'd put a blank line before "For more information see:", like:

~~~
GDB is a collaborative project that relies on contributions.  You can
help with this!  You may wish to fix bugs, improve testing, port GDB
to a new platform, update documentation, add new features or
optimizations, contribute to the mailing lists or official GDB
website, etc.  We welcome all of the above and feel free to ask on the
GDB mailing lists if you are looking for feedback or for people to
review a work in progress.

For more information see:

https://sourceware.org/gdb/contribute/
~~~

> 
> 
> 
> 
> For the webpage, how about the following. Everything in a [] is a link which
> needs replacing with the relevant link from the list at the end (and the list
> itself deleted).
> 
> 
> 
> 			Contributing to GDB
> 
> GDB is a collaborative project that relies on contributions.  You can help in this!  You may wish to fix bugs, improve testing, port GDB to a new platform, update documentation, add new features or optimizations, contribute to the mailing lists or official GDB website, etc.  We welcome all of the above and feel free to ask on the [GDB Mailing Lists] if you are looking for feedback or for people to review a work in progress.
> 
> To help with this, there is plenty of documentation available.  In addition to the [User Guide] and [Internals Manual] included in the GDB distribution, the [GDB Wiki] also contain substantial information.  If you are looking for a project then check the [Project Ideas] page.

"also contain" -> "also contains"

> 
> If you write a change to the GDB codebase we encourage you to distribute the change yourself.  You may also want to submit your change so that can be considered for inclusion in a future version of GDB.  If so then there are certain legal requirements and style issues which all contributors need to be aware of - for more details please read the [Contribution Checklist].
> 
> 
> [GDB Mailing Lists] https://sourceware.org/gdb/mailing-lists/
> [User Guide] https://sourceware.org/gdb/current/onlinedocs/gdb/
> [Internals Manual] https://sourceware.org/gdb/wiki/Internals
> [GDB Wiki] https://sourceware.org/gdb/wiki/
> [Project Ideas] https://sourceware.org/gdb/wiki/ProjectIdeas
> [Contribution Checklist] https://sourceware.org/gdb/wiki/ContributionChecklist
> 
> 

Looks good to me!

Thanks,
Pedro Alves


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]