Skip to content

Commit c85cace

Browse files
ssddanbrownssddanbrown
committed
Updated readme, license and added code of conduct
1 parent 4f78838 commit c85cace

3 files changed

Lines changed: 101 additions & 12 deletions

File tree

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance, race,
10+
religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Being respectful of differing viewpoints and experiences
18+
* Gracefully accepting constructive criticism
19+
* Focusing on what is best for the community
20+
* Showing empathy towards other community members
21+
22+
Examples of unacceptable behavior by participants include:
23+
24+
* The use of sexualized language or imagery and unwelcome sexual attention or
25+
advances
26+
* Trolling, insulting/derogatory comments, and personal or political attacks
27+
* Public or private harassment
28+
* Publishing others' private information, such as a physical or electronic
29+
address, without explicit permission
30+
* Other conduct which could reasonably be considered inappropriate in a
31+
professional setting
32+
33+
### Project Maintainer Standards
34+
35+
Project maintainers should generally follow these additional standards:
36+
37+
* Avoid using a negative or harsh tone in communication, Even if the other party
38+
is being negative themselves.
39+
* Keep the [project definition](https://github.com/BookStackApp/BookStack#project-definition)
40+
in mind when deciding what's in scope of the Project.
41+
42+
## Our Responsibilities
43+
44+
Project maintainers are responsible for clarifying the standards of acceptable
45+
behavior and are expected to take appropriate and fair corrective action in
46+
response to any instances of unacceptable behavior. In addition, Project
47+
maintainers are responsible for following the standards themselves.
48+
49+
Project maintainers have the right and responsibility to remove, edit, or
50+
reject comments, commits, code, wiki edits, issues, and other contributions
51+
that are not aligned to this Code of Conduct, or to ban temporarily or
52+
permanently any contributor for other behaviors that they deem inappropriate,
53+
threatening, offensive, or harmful.
54+
55+
## Scope
56+
57+
This Code of Conduct applies both within project spaces and in public spaces
58+
when an individual is representing the project or its community. Examples of
59+
representing a project or community include using an official project e-mail
60+
address, posting via an official social media account, or acting as an appointed
61+
representative at an online or offline event. Representation of a project may be
62+
further defined and clarified by project maintainers.
63+
64+
## Enforcement
65+
66+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
67+
reported by contacting the project team at the email address shown on [the profile here](https://github.com/ssddanbrown). All
68+
complaints will be reviewed and investigated and will result in a response that
69+
is deemed necessary and appropriate to the circumstances. The project team is
70+
obligated to maintain confidentiality with regard to the reporter of an incident.
71+
Further details of specific enforcement policies may be posted separately.
72+
73+
Project maintainers who do not follow or enforce the Code of Conduct in good
74+
faith may face temporary or permanent repercussions as determined by other
75+
members of the project's leadership.
76+
77+
## Attribution
78+
79+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
80+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
81+
82+
[homepage]: https://www.contributor-covenant.org

‎LICENSE‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 Dan Brown
3+
Copyright (c) 2018 Dan Brown and the BookStack Project contributors
4+
https://github.com/BookStackApp/BookStack/graphs/contributors
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy
67
of this software and associated documentation files (the "Software"), to deal

‎readme.md‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,27 @@ A platform for storing and organising information and documentation. General inf
1717

1818
BookStack is an opinionated wiki system that provides a pleasant and simple out of the box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it but they should not interfere with the core simple user experience.
1919

20-
BookStack is not designed as an extensible platform to be used for purposes that differ to the statement above.
20+
BookStack is not designed as an extensible platform to be used for purposes that differ to the statement above.
21+
22+
In regards to development philosophy, BookStack has a relaxed, open & positive approach. Put simply, At the end of the day this is free software developed and maintained by people donating their own free time.
2123

2224
## Development & Testing
2325

2426
All development on BookStack is currently done on the master branch. When it's time for a release the master branch is merged into release with built & minified CSS & JS then tagged at its version. Here are the current development requirements:
2527

2628
* [Node.js](https://nodejs.org/en/) v6.9+
2729

28-
SASS is used to help the CSS development and the JavaScript is run through browserify/babel to allow for writing ES6 code. Both of these are done using gulp. To run the build task you can use the following commands:
30+
SASS is used to help the CSS development and the JavaScript is run through babel to allow for writing ES6 code. This is done using webpack. To run the build task you can use the following commands:
2931

3032
``` bash
3133
# Build assets for development
32-
npm run-script build
34+
npm run build
3335

3436
# Build and minify assets for production
35-
npm run-script production
37+
npm run production
3638

3739
# Build for dev (With sourcemaps) and watch for changes
38-
npm run-script dev
40+
npm run dev
3941
```
4042

4143
BookStack has many integration tests that use Laravel's built-in testing capabilities which makes use of PHPUnit. To use you will need PHPUnit installed and accessible via command line. There is a `mysql_testing` database defined within the app config which is what is used by PHPUnit. This database is set with the following database name, user name and password defined as `bookstack-test`. You will have to create that database and credentials before testing.
@@ -65,14 +67,16 @@ php resources/lang/check.php <lang>
6567
php resources/lang/check.php fr
6668
php resources/lang/check.php pt_BR
6769
```
68-
70+
6971
Some strings have colon-prefixed variables in such as `:userName`. Leave these values as they are as they will be replaced at run-time.
70-
71-
## Contributing
72+
73+
## Contributing & Maintenence
7274

7375
Feel free to create issues to request new features or to report bugs and problems. Just please follow the template given when creating the issue.
7476

75-
### Standards
77+
The project's code of conduct [can be found here](https://github.com/BookStackApp/BookStack/blob/master/.github/CODE_OF_CONDUCT.md).
78+
79+
### Code Standards
7680

7781
PHP code within BookStack is generally to [PSR-2](http://www.php-fig.org/psr/psr-2/) standards. From the BookStack root folder you can run `./vendor/bin/phpcs` to check code is formatted correctly and `./vendor/bin/phpcbf` to auto-fix non-PSR-2 code.
7882

@@ -82,9 +86,9 @@ Pull requests are very welcome. If the scope of your pull request is large it ma
8286

8387
Pull requests should be created from the `master` branch and should be merged back into `master` once done. Please do not build from or request a merge into the `release` branch as this is only for publishing releases.
8488

85-
If you are looking to alter CSS or JavaScript content please edit the source files found in `resources/assets`. Any CSS or JS files within `public` are built from these source files and therefore should not be edited directly.
89+
If you are looking to alter CSS or JavaScript content please edit the source files found in `resources/assets`. Any CSS or JS files within `public` are built from these source files and therefore should not be edited directly.
8690

87-
## Website, Docs & Blog
91+
## Website, Docs & Blog
8892

8993
The website project docs & Blog can be found in the [BookStackApp/website](https://github.com/BookStackApp/website) repo.
9094

@@ -94,6 +98,8 @@ The BookStack source is provided under the MIT License.
9498

9599
## Attribution
96100

101+
The great people that have worked to build and improve BookStack can [be seen here](https://github.com/BookStackApp/BookStack/graphs/contributors).
102+
97103
These are the great open-source projects used to help build BookStack:
98104

99105
* [Laravel](http://laravel.com/)

0 commit comments

Comments
 (0)