Skip to content

Commit 61212ab

Browse files
committed
sync standard repo files with .github repo per creativecommons/.github#26
1 parent 1e62fcd commit 61212ab

File tree

2 files changed

+57
-13
lines changed

2 files changed

+57
-13
lines changed

CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ For a history of updates, see the [page history here][updates].
1010

1111
[code_of_conduct]: https://opensource.creativecommons.org/community/code-of-conduct/
1212
[reporting_guide]: https://opensource.creativecommons.org/community/code-of-conduct/enforcement/
13-
[updates]: https://github.com/creativecommons/creativecommons.github.io-source/commits/master/content/community/code-of-conduct/contents.lr
13+
[updates]: https://github.com/creativecommons/creativecommons.github.io-source/commits/main/content/community/code-of-conduct/contents.lr

CONTRIBUTING.md

+56-12
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,91 @@
11
# Contributing to CC Open Source
22

3-
Thank you for your interest in contributing to CC Open Source! This document is a set of guidelines to help you contribute to this project.
3+
Thank you for your interest in contributing to CC Open Source! This document is
4+
a set of guidelines to help you contribute to this project.
5+
46

57
## Code of Conduct
68

7-
By participating in this project, you are expected to uphold our [Code of Conduct](https://opensource.creativecommons.org/community/code-of-conduct/).
9+
By participating in this project, you are expected to uphold our [Code of
10+
Conduct][code_of_conduct].
11+
12+
[code_of_conduct]: https://opensource.creativecommons.org/community/code-of-conduct/
13+
814

915
## Project Documentation
1016

11-
Please consult the [README](./README.md) and [CODEBASE](./CODEBASE.md) files at the root of this repository.
17+
The `README` in the root of the repository should contain or link to project
18+
documentation. If you cannot find the documentation you're looking for, please
19+
file a GitHub issue with details of what you'd like to see documented.
20+
1221

1322
## How to Contribute
1423

15-
Please read the processes in our general [Contributing Code](https://opensource.creativecommons.org/contributing-code/) guidelines on the Creative Common Open Source website. It contains some general instructions that should be followed when contributing to any of the Creative Commons open-source repositories.
24+
Please follow the processes in our general [Contributing Code][contributing]
25+
guidelines on the Creative Common Open Source website.
26+
27+
[contributing]: https://opensource.creativecommons.org/contributing-code/
28+
1629

1730
### Bugs
1831

19-
If you find a bug, please open an issue in this repository describing the bug. You can file a bug [here](https://github.com/creativecommons/og-image-generator/issues/new?template=bug_report.md). You will see a bug report template with the required information you should provide.
32+
If you find a bug, please open an issue in this repository describing the bug.
33+
You can file a bug
34+
[here](https://github.com/creativecommons/og-image-generator/issues/new?template=bug_report.md).
35+
You will see a bug report template with the required information you should
36+
provide.
2037

2138
After that, don't forget to tag the issue with the "Bug" label.
2239

40+
2341
### Proposing changes or new features
2442

25-
If you have an idea of a new feature or change to how the CC Search frontend works, please [file an issue](https://github.com/creativecommons/og-image-generator/issues/new?template=feature_request.md) so we can discuss the possibility of that change or new feature being implemented and released in the future. This lets us come to an agreement about the proposed idea before any work is done.
43+
If you have an idea of a new feature or change to how the CC Search frontend
44+
works, please [file an issue][featurereq] so we can discuss the possibility of
45+
that change or new feature being implemented and released in the future. This
46+
lets us come to an agreement about the proposed idea before any work is done.
47+
48+
If you'd like to build a new feature but don't have a specific idea, please
49+
check our [public roadmap][roadmap]. Choose something from the pipeline of
50+
ideas and follow the same process as above.
51+
52+
[featurereq]: https://github.com/creativecommons/og-image-generator/issues/new?template=feature_request.md
53+
[roadmap]: https://docs.google.com/document/d/19yH2V5K4nzWgEXaZhkzD1egzrRayyDdxlzxZOTCm_pc/
2654

27-
If you'd like to build a new feature but don't have a specific idea, please check our [public roadmap](https://docs.google.com/document/d/19yH2V5K4nzWgEXaZhkzD1egzrRayyDdxlzxZOTCm_pc/). Choose something from the pipeline of ideas and follow the same process as above.
2855

2956
### Pull requests
3057

31-
Before you start writing code, make sure there is an issue open. Pull requests without a link to an existing issue won't be merged. All pull requests _must_ target the `develop` branch of the repository.
58+
Before you start writing code, make sure there is an issue open. Pull requests
59+
without a link to an existing issue won't be merged. All pull requests _must_
60+
target the `develop` branch of the repository.
3261

33-
If you want to get started contributing code to this project but don't know exactly what to work on, we compiled a good list of issues labeled as [Good first issues](https://github.com/creativecommons/og-image-generator/labels/good%20first%20issue) which are small in scope and not so complex to solve. There is also issues labeld as [Help wanted](https://github.com/creativecommons/og-image-generator/labels/help%20wanted) which can be a bit more complex but are good examples of thigns we are currently accepting help from the community.
62+
If you want to get started contributing code to this project but don't know
63+
exactly what to work on, we compiled a good list of issues labeled as [Good
64+
first issues][firstissue] which are small in scope and not so complex to solve.
65+
There is also issues labeld as [Help wanted][helpwanted] which can be a bit
66+
more complex but are good examples of thigns we are currently accepting help
67+
from the community.
3468

35-
Any code modifications will have to be accompanied by the appropriate unit tests. This will be checked and verified during code review. Once the Pull Reques is opened, our CI server will run the unit test suite and run a code linter to verify that the code follows the coding guidelines.
69+
Any code modifications will have to be accompanied by the appropriate unit
70+
tests. This will be checked and verified during code review. Once the Pull
71+
Reques is opened, our CI server will run the unit test suite and run a code
72+
linter to verify that the code follows the coding guidelines.
3673

3774
If you want to run the unit tests and linter on your machine, run the following commands:
3875

3976
`npm run unit` for unit tests
4077

4178
`npm run lint` for linter.
4279

43-
You can also configure your editor of choice with a ESLint plugin so you can get the linter feedback as you write code.
80+
You can also configure your editor of choice with a ESLint plugin so you can
81+
get the linter feedback as you write code.
82+
83+
[firstissue]: https://github.com/creativecommons/og-image-generator/labels/good%20first%20issue
84+
[helpwanted]: https://github.com/creativecommons/og-image-generator/labels/help%20wanted
85+
4486

4587
## Questions or Thoughts?
4688

47-
Talk to us on [our developer mailing list or Slack community](https://opensource.creativecommons.org/community/).
89+
Talk to us on [one of our community forums][community].
90+
91+
[community]: https://opensource.creativecommons.org/community/

0 commit comments

Comments
 (0)