Skip to content

Commit 2541011

Browse files
Replace hyphen with asterisk in starting-a-project.md
1 parent d188d50 commit 2541011

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

_articles/bn/starting-a-project.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ _Free software_ refers to the same set of projects as _open source_. Sometimes y
3434

3535
[There are many reasons](https://ben.balter.com/2015/11/23/why-open-source/) why a person or organization would want to open source a project. Some examples include:
3636

37-
- **Collaboration:** Open source projects can accept changes from anybody in the world. [Exercism](https://github.com/exercism/), for example, is a programming exercise platform with over 350 contributors.
37+
* **Collaboration:** Open source projects can accept changes from anybody in the world. [Exercism](https://github.com/exercism/), for example, is a programming exercise platform with over 350 contributors.
3838

39-
- **Adoption and remixing:** Open source projects can be used by anyone for nearly any purpose. People can even use it to build other things. [WordPress](https://github.com/WordPress), for example, started as a fork of an existing project called [b2](https://github.com/WordPress/book/blob/HEAD/Content/Part%201/2-b2-cafelog.md).
39+
* **Adoption and remixing:** Open source projects can be used by anyone for nearly any purpose. People can even use it to build other things. [WordPress](https://github.com/WordPress), for example, started as a fork of an existing project called [b2](https://github.com/WordPress/book/blob/HEAD/Content/Part%201/2-b2-cafelog.md).
4040

41-
- **Transparency:** Anyone can inspect an open source project for errors or inconsistencies. Transparency matters to governments like [Bulgaria](https://medium.com/@bozhobg/bulgaria-got-a-law-requiring-open-source-98bf626cf70a) or the [United States](https://www.cio.gov/2016/08/11/peoples-code.html), regulated industries like banking or healthcare, and security software like [Let's Encrypt](https://github.com/letsencrypt).
41+
* **Transparency:** Anyone can inspect an open source project for errors or inconsistencies. Transparency matters to governments like [Bulgaria](https://medium.com/@bozhobg/bulgaria-got-a-law-requiring-open-source-98bf626cf70a) or the [United States](https://www.cio.gov/2016/08/11/peoples-code.html), regulated industries like banking or healthcare, and security software like [Let's Encrypt](https://github.com/letsencrypt).
4242

4343
Open source isn't just for software, either. You can open source everything from data sets to books. Check out [GitHub Explore](https://github.com/explore) for ideas on what else you can open source.
4444

@@ -106,10 +106,10 @@ Generally speaking, you should open source your project when you feel comfortabl
106106

107107
No matter which stage you decide to open source your project, every project should include the following documentation:
108108

109-
- [Open source license](https://help.github.com/articles/open-source-licensing/#where-does-the-license-live-on-my-repository)
110-
- [README](https://help.github.com/articles/create-a-repo/#commit-your-first-change)
111-
- [Contributing guidelines](https://help.github.com/articles/setting-guidelines-for-repository-contributors/)
112-
- [Code of conduct](../code-of-conduct/)
109+
* [Open source license](https://help.github.com/articles/open-source-licensing/#where-does-the-license-live-on-my-repository)
110+
* [README](https://help.github.com/articles/create-a-repo/#commit-your-first-change)
111+
* [Contributing guidelines](https://help.github.com/articles/setting-guidelines-for-repository-contributors/)
112+
* [Code of conduct](../code-of-conduct/)
113113

114114
As a maintainer, these components will help you communicate expectations, manage contributions, and protect everyone's legal rights (including your own). They significantly increase your chances of having a positive experience.
115115

@@ -135,10 +135,10 @@ READMEs do more than explain how to use your project. They also explain why your
135135

136136
In your README, try to answer the following questions:
137137

138-
- What does this project do?
139-
- Why is this project useful?
140-
- How do I get started?
141-
- Where can I get more help, if I need it?
138+
* What does this project do?
139+
* Why is this project useful?
140+
* How do I get started?
141+
* Where can I get more help, if I need it?
142142

143143
You can use your README to answer other questions, like how you handle contributions, what the goals of the project are, and information about licenses and attribution. If you don't want to accept contributions, or your project is not yet ready for production, write this information down.
144144

@@ -160,15 +160,15 @@ When you include a README file in the root directory, GitHub will automatically
160160

161161
A CONTRIBUTING file tells your audience how to participate in your project. For example, you might include information on:
162162

163-
- How to file a bug report (try using [issue and pull request templates](https://github.com/blog/2111-issue-and-pull-request-templates))
164-
- How to suggest a new feature
165-
- How to set up your environment and run tests
163+
* How to file a bug report (try using [issue and pull request templates](https://github.com/blog/2111-issue-and-pull-request-templates))
164+
* How to suggest a new feature
165+
* How to set up your environment and run tests
166166

167167
In addition to technical details, a CONTRIBUTING file is an opportunity to communicate your expectations for contributions, such as:
168168

169-
- The types of contributions you're looking for
170-
- Your roadmap or vision for the project
171-
- How contributors should (or should not) get in touch with you
169+
* The types of contributions you're looking for
170+
* Your roadmap or vision for the project
171+
* How contributors should (or should not) get in touch with you
172172

173173
Using a warm, friendly tone and offering specific suggestions for contributions (such as writing documentation, or making a website) can go a long way in making newcomers feel welcomed and excited to participate.
174174

@@ -214,8 +214,8 @@ Branding is more than a flashy logo or catchy project name. It's about how you t
214214

215215
Pick a name that is easy to remember and, ideally, gives some idea of what the project does. For example:
216216

217-
- [Sentry](https://github.com/getsentry/sentry) monitors apps for crash reporting
218-
- [Thin](https://github.com/macournoyer/thin) is a fast and simple Ruby web server
217+
* [Sentry](https://github.com/getsentry/sentry) monitors apps for crash reporting
218+
* [Thin](https://github.com/macournoyer/thin) is a fast and simple Ruby web server
219219

220220
If you're building upon an existing project, using their name as a prefix can help clarify what your project does (for example, [node-fetch](https://github.com/bitinn/node-fetch) brings `window.fetch` to Node.js).
221221

0 commit comments

Comments
 (0)