adding a CONTRIBUTING.md file - #868
Amrit-raj50 wants to merge 7 commits into
Conversation
|
@chriscool @sivaraam — Could you take a look at this when you get |
| @@ -0,0 +1,144 @@ | |||
| # Contributing to Git Developer Pages | |||
|
|
|||
| Thank you for your interest in contributing to [git.github.io](https://git.github.io) — the community website for Git development, home to the [Git Rev News newsletter](https://git.github.io/rev_news/), [Hacking Git](https://git.github.io/Hacking-Git/), and mentoring program information. | |||
There was a problem hiding this comment.
Please avoid long lines like this. Instead please split them at around 72 characters.
Also please avoid — characters. It looks too much AI generated.
| --- | ||
|
|
||
| ## Ways to Contribute | ||
|
|
There was a problem hiding this comment.
Please add an introduction sentence, like "In general we accept all kind of contributions to all the pages on this website, but here are some suggestions along with a few guidelines:"
|
|
||
| ## Ways to Contribute | ||
|
|
||
| - Fix typos, broken links, or outdated information |
| ## Ways to Contribute | ||
|
|
||
| - Fix typos, broken links, or outdated information | ||
| - Improve or add pages under `links/`, `rev_news/`, or other sections |
There was a problem hiding this comment.
I am not sure listing those directories make sense. I think it would make more sense to list the section on the website instead.
|
|
||
| - Fix typos, broken links, or outdated information | ||
| - Improve or add pages under `links/`, `rev_news/`, or other sections | ||
| - Add entries to the Git Rev News newsletter |
There was a problem hiding this comment.
It's not clear what "entries" means here. I think this should be more detailed. It should say what could be added in which section, how to find the upcoming edition where things can be added, and so on.
| - Fix typos, broken links, or outdated information | ||
| - Improve or add pages under `links/`, `rev_news/`, or other sections | ||
| - Add entries to the Git Rev News newsletter | ||
| - Improve site infrastructure (CSS, JavaScript, Jekyll layouts/plugins) |
There was a problem hiding this comment.
For any big improvement, people should look at existing issues and if needed create a new one before starting to work.
| - Add entries to the Git Rev News newsletter | ||
| - Improve site infrastructure (CSS, JavaScript, Jekyll layouts/plugins) | ||
| - Report issues via [GitHub Issues](https://github.com/git/git.github.io/issues) | ||
|
|
There was a problem hiding this comment.
They could also give their opinion on existing issues or review existing MRs.
| git checkout -b my-fix | ||
| ``` | ||
| 4. **Make your changes**, following the [Writing Guidelines](#writing-guidelines) below. | ||
| 5. **Test locally** by [running the site](#running-the-site-locally) and verifying your changes look correct. |
There was a problem hiding this comment.
It's not necessary to test their changes locally when contributing to a Git Rev News edition.
| 6. **Commit** with a clear, descriptive message: | ||
| ```sh | ||
| git add . | ||
| git commit -m "Brief description of the change" |
There was a problem hiding this comment.
When working on a Git Rev News edition, the subject should start with "rn-XXX: " where XXX is the edition you are working on.
| If you want to contribute to a newsletter edition: | ||
| - Check the [news sources](https://git.github.io/rev_news/news_sources/) page for submission guidelines. | ||
| - Contact the maintainers via email (see [above](#submitting-changes-via-email)). | ||
|
|
There was a problem hiding this comment.
There is an issue created for each edition. It's best to contact us on this issue if you want to contribute to an edition.
|
@Amrit-raj50 I have left a number of comments. Thanks. |
|
I will raise the new PR for this after thrusday |
This branch has not been deployed
2 participants
This PR adds a CONTRIBUTING.md file to the repository.
GitHub automatically surfaces this file to anyone who opens a new
issue or pull request, helping new contributors understand how to
participate before they submit anything.
The file covers:
All information is based on the existing README.md and repository
conventions — nothing new is introduced, just consolidated in one
place for contributor discoverability.
Closes/Relates to: (add issue number if one exists)
issue : #864